static

Documentation

Index

• Constants
• type Config
  • func (c *Config) AlwaysForbid(filename string) bool
  • func (c *Config) AlwaysServe(filename string) bool
  • func (c *Config) Hydrate(cfg service.Config) error
  • func (c *Config) Valid() error
• type Service
  • func (s *Service) Init(cfg *Config, r *rrhttp.Service) (bool, error)

Constants

const ID = "static"

ID contains default service name.

Types

type Config

type Config struct {
	// Dir contains name of directory to control access to.
	Dir string

	// Forbid specifies list of file extensions which are forbidden for access.
	// Example: .php, .exe, .bat, .htaccess and etc.
	Forbid []string

	// Always specifies list of extensions which must always be served by static
	// service, even if file not found.
	Always []string
}

Config describes file location and controls access to them.

func (*Config) AlwaysForbid

func (c *Config) AlwaysForbid(filename string) bool

AlwaysForbid must return true if file extension is not allowed for the upload.

func (*Config) AlwaysServe

func (c *Config) AlwaysServe(filename string) bool

AlwaysServe must indicate that file is expected to be served by static service.

func (*Config) Hydrate

func (c *Config) Hydrate(cfg service.Config) error

Hydrate must populate Config values using given Config source. Must return error if Config is not valid.

func (*Config) Valid

func (c *Config) Valid() error

Valid returns nil if config is valid.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service serves static files. Potentially convert into middleware?

func (*Service) Init

func (s *Service) Init(cfg *Config, r *rrhttp.Service) (bool, error)

Init must return configure service and return true if service hasStatus enabled. Must return error in case of misconfiguration. Services must not be used without proper configuration pushed first.