imageboard

Documentation

Index

• type Config
  • func (c *Config) SetDefaults()
• type ImageBoard
  • func New(fs afero.Fs, cfg *Config, logger *zap.Logger) (*ImageBoard, error)
  • func (i *ImageBoard) Disable()
  • func (i *ImageBoard) Enable()
  • func (i *ImageBoard) Enabled() bool
  • func (i *ImageBoard) GetHTTPHandlers() ([]*board.HTTPHandler, error)
  • func (i *ImageBoard) HasPriority() bool
  • func (i *ImageBoard) Name() string
  • func (i *ImageBoard) Render(ctx context.Context, canvas board.Canvas) error
  • func (i *ImageBoard) ScrollMode() bool

Types

type Config

type Config struct {
	BoardDelay   string       `json:"boardDelay"`
	Enabled      *atomic.Bool `json:"enabled"`
	Directories  []string     `json:"directories"`
	UseDiskCache *atomic.Bool `json:"useDiskCache"`
	UseMemCache  *atomic.Bool `json:"useMemCache"`
	// contains filtered or unexported fields
}

Config ...

func (*Config) SetDefaults

func (c *Config) SetDefaults()

SetDefaults sets some Config defaults

type ImageBoard

type ImageBoard struct {
	sync.Mutex
	// contains filtered or unexported fields
}

ImageBoard is a board for displaying image files

func New

func New(fs afero.Fs, cfg *Config, logger *zap.Logger) (*ImageBoard, error)

New ...

func (*ImageBoard) Disable

func (i *ImageBoard) Disable()

Disable ...

func (*ImageBoard) Enable

func (i *ImageBoard) Enable()

Enable ...

func (*ImageBoard) Enabled

func (i *ImageBoard) Enabled() bool

Enabled ...

func (*ImageBoard) GetHTTPHandlers

func (i *ImageBoard) GetHTTPHandlers() ([]*board.HTTPHandler, error)

GetHTTPHandlers ...

func (*ImageBoard) HasPriority

func (i *ImageBoard) HasPriority() bool

HasPriority ...

func (*ImageBoard) Name

func (i *ImageBoard) Name() string

Name ...

func (*ImageBoard) Render

func (i *ImageBoard) Render(ctx context.Context, canvas board.Canvas) error

Render ...

func (*ImageBoard) ScrollMode

func (i *ImageBoard) ScrollMode() bool

ScrollMode ...