config

Documentation

Index

• func ContextWithConfig(ctx context.Context) (context.Context, error)
• type ConfigOption
  • func WithFlags() ConfigOption
• type Configuration
  • func GetConfigFromContext(ctx context.Context) *Configuration
  • func NewConfig(ctx context.Context, opts ...ConfigOption) (*Configuration, error)

Functions

func ContextWithConfig

func ContextWithConfig(ctx context.Context) (context.Context, error)

Types

type ConfigOption

type ConfigOption func(*Configuration) error

ConfigOption defines a type of function to configures the Config.

func WithFlags

func WithFlags() ConfigOption

WithFlags parses the command line, and populates the configuration.

type Configuration

type Configuration struct {
	ConfigPath string
	// contains filtered or unexported fields
}

Configuration represents the configuration as set by command-line flags. All variables will be set, unless explicitly noted.

func GetConfigFromContext

func GetConfigFromContext(ctx context.Context) *Configuration

func NewConfig

func NewConfig(ctx context.Context, opts ...ConfigOption) (*Configuration, error)

NewConfig creates a new Config.