killgrave

Documentation

Index

• func AttachWatcher(w *watcher.Watcher, fn func())
• func InitializeWatcher(pathToWatch string) (*watcher.Watcher, error)
• type Config
  • func NewConfig(impostersPath, host string, port int, secure bool, opts ...ConfigOpt) (Config, error)
• type ConfigCORS
• type ConfigOpt
  • func WithConfigFile(cfgPath string) ConfigOpt
  • func WithProxyConfiguration(proxyMode, proxyURL string) ConfigOpt
  • func WithWatcherConfiguration(watcher bool) ConfigOpt
• type ConfigProxy
• type ProxyMode
  • func StringToProxyMode(t string) (ProxyMode, error)
  • func (p ProxyMode) String() string
  • func (p *ProxyMode) UnmarshalYAML(unmarshal func(interface{}) error) error

Functions

func AttachWatcher

func AttachWatcher(w *watcher.Watcher, fn func())

AttachWatcher start the watcher, if any error was produced while the starting process the application would crash you need to pass a function, this function is the function that will be executed when the watcher receive any event the type of defined on the InitializeWatcher function

func InitializeWatcher

func InitializeWatcher(pathToWatch string) (*watcher.Watcher, error)

InitializeWatcher initialize a watcher to check for modification on all files in the given path to watch

Types

type Config

type Config struct {
	ImpostersPath string      `yaml:"imposters_path"`
	Port          int         `yaml:"port"`
	Host          string      `yaml:"host"`
	CORS          ConfigCORS  `yaml:"cors"`
	Proxy         ConfigProxy `yaml:"proxy"`
	Secure        bool        `yaml:"secure"`
	Watcher       bool        `yaml:"watcher"`
}

Config representation of config file yaml

func NewConfig

func NewConfig(impostersPath, host string, port int, secure bool, opts ...ConfigOpt) (Config, error)

NewConfig initialize the config

type ConfigCORS

type ConfigCORS struct {
	Methods          []string `yaml:"methods"`
	Headers          []string `yaml:"headers"`
	Origins          []string `yaml:"origins"`
	ExposedHeaders   []string `yaml:"exposed_headers"`
	AllowCredentials bool     `yaml:"allow_credentials"`
}

ConfigCORS representation of section CORS of the yaml

type ConfigOpt

type ConfigOpt func(cfg *Config) error

ConfigOpt function to encapsulate optional parameters

func WithConfigFile

func WithConfigFile(cfgPath string) ConfigOpt

WithConfigFile unmarshal content of config file to Config struct

func WithProxyConfiguration

func WithProxyConfiguration(proxyMode, proxyURL string) ConfigOpt

WithProxyConfiguration preparing the server with the proxy configuration that the user has indicated

func WithWatcherConfiguration

func WithWatcherConfiguration(watcher bool) ConfigOpt

WithWatcherConfiguration preparing server to do auto-reload

type ConfigProxy

type ConfigProxy struct {
	URL  string    `yaml:"url"`
	Mode ProxyMode `yaml:"mode"`
}

ConfigProxy is a representation of section proxy of the yaml

type ProxyMode

type ProxyMode uint8

ProxyMode is enumeration of proxy server modes

const (
	// ProxyNone server is off
	ProxyNone ProxyMode = iota
	// ProxyMissing handle only missing requests are proxied
	ProxyMissing
	// ProxyAll all requests are proxied
	ProxyAll
)

func StringToProxyMode

func StringToProxyMode(t string) (ProxyMode, error)

StringToProxyMode convert string into a ProxyMode if not exists return a none mode and an error

func (ProxyMode) String

func (p ProxyMode) String() string

func (*ProxyMode) UnmarshalYAML

func (p *ProxyMode) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implementation of yaml.Unmarshaler interface