config

Documentation

Index

• Variables
• type Config
  • func File(path string) (*Config, error)
  • func Reader(r io.Reader) (*Config, error)
  • func (cfg *Config) Dog(ctx context.Context, opts ...Option) (*postdog.Dog, error)
  • func (cfg *Config) Parse(raw []byte) error
  • func (cfg *Config) Transport(name string) (tr Transport, ok bool)
• type Option
  • func WithOptions(opts ...postdog.Option) Option
  • func WithTransportFactory(use string, factory TransportFactory) Option
• type Transport
• type TransportFactory
• type TransportFactoryFunc
  • func (fn TransportFactoryFunc) Transport(ctx context.Context, m map[string]interface{}) (postdog.Transport, error)

Variables

var (
	// ErrUnknownTransport means a TransportFactory is missing for a transport.
	ErrUnknownTransport = errors.New("unknown transport")
)

Types

type Config

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

Config is the postdog configuration.

func File

func File(path string) (*Config, error)

File parses the configuration file at path into a Config.

func Reader

func Reader(r io.Reader) (*Config, error)

Reader parses the configuration in r into a Config.

func (*Config) Dog

func (cfg *Config) Dog(ctx context.Context, opts ...Option) (*postdog.Dog, error)

Dog instantiates the *postdog.Dog from the parsed configuration.

For every distinct `transport.use` config value a TransportFactory must be provided. It will return ErrUnknownTransport if a TransportFactory is missing.

func (*Config) Parse

func (cfg *Config) Parse(raw []byte) error

Parse parses the YAML configuration in raw.

func (*Config) Transport

func (cfg *Config) Transport(name string) (tr Transport, ok bool)

Transport returns the transport configuration for the given name, or ok=false if the config doesn't have a transport with that name.

type Option

type Option func(*Config)

Option is an option for the (*Config).Dog() method.

func WithOptions

func WithOptions(opts ...postdog.Option) Option

WithOptions returns an Option that adds postdog.Options to the postdog.Dog returned by cfg.Dog().

func WithTransportFactory

func WithTransportFactory(use string, factory TransportFactory) Option

WithTransportFactory returns an Option that specifies the TransportFactory for a `transport.use` value.

type Transport

type Transport struct {
	Use    string                 `yaml:"use"`
	Config map[string]interface{} `yaml:"config"`
}

Transport is a transport configuration.

type TransportFactory

type TransportFactory interface {
	Transport(context.Context, map[string]interface{}) (postdog.Transport, error)
}

A TransportFactory accepts the transport-specific configuration and instantiates a transport from that configuration.

type TransportFactoryFunc

type TransportFactoryFunc func(context.Context, map[string]interface{}) (postdog.Transport, error)

TransportFactoryFunc allows functions to be used as TransportFactories.

func (TransportFactoryFunc) Transport

func (fn TransportFactoryFunc) Transport(ctx context.Context, m map[string]interface{}) (postdog.Transport, error)

Transport accepts the transport-specific configuration and instantiates a transport from that configuration.