config

package

v0.16.1 Latest Latest Go to latest Published: Feb 1, 2022 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bounoable/postdog

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Config
- func File(path string) (*Config, error)
- func Reader(r io.Reader) (*Config, error)
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)

Constants ¶

This section is empty.

Variables ¶

View Source

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

Functions ¶

This section is empty.

Types ¶

type Config ¶

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

Config is the postdog configuration.

func File ¶ added in v0.9.4

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

File parses the configuration file at path into a Config.

func Reader ¶ added in v0.9.4

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 ¶ added in v0.9.6

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 ¶ added in v0.9.5

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

TransportFactoryFunc allows functions to be used as TransportFactories.

func (TransportFactoryFunc) Transport ¶ added in v0.9.5

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.

Source Files ¶

View all Source files

config.go

Directories ¶

Path	Synopsis
mocks Package mock_config is a generated GoMock package.	Package mock_config is a generated GoMock package.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL