injectable

Documentation

Index

• func ConfigFromContext(ctx context.Context, defaulters ...func() *viper.Viper) *viper.Viper
• func SLoggerFromContext(ctx context.Context, defaulters ...func() *slog.Logger) *slog.Logger
• func ZapLoggerFromContext(ctx context.Context, defaulters ...func() *zap.Logger) *zap.Logger
• type Config
  • func NewConfig(v *viper.Viper) *Config
  • func (c *Config) Context(ctx context.Context) context.Context
  • func (c Config) FromContext(ctx context.Context) interface{}
• type ContextInjectable
• type SLogger
  • func NewSLogger(l *slog.Logger) *SLogger
  • func (c *SLogger) Context(ctx context.Context) context.Context
  • func (c SLogger) FromContext(ctx context.Context) interface{}
• type ZapLogger
  • func NewZapLogger(l *zap.Logger) *ZapLogger
  • func (c *ZapLogger) Context(ctx context.Context) context.Context
  • func (c ZapLogger) FromContext(ctx context.Context) interface{}

Functions

func ConfigFromContext

func ConfigFromContext(ctx context.Context, defaulters ...func() *viper.Viper) *viper.Viper

ConfigFromContext retrieves a configuration registry from the context.

An optional defaulter can be added to deal with a non-existing config.

func SLoggerFromContext

func SLoggerFromContext(ctx context.Context, defaulters ...func() *slog.Logger) *slog.Logger

SLoggerFromContext retrieves a standard structured logger from the context.

Optional defaulters can be added to deal with a non-existing logger.

func ZapLoggerFromContext

func ZapLoggerFromContext(ctx context.Context, defaulters ...func() *zap.Logger) *zap.Logger

ZapLoggerFromContext retrieves a zap logger from the context.

Optional defaulters can be added to deal with a non-existing logger.

Types

type Config

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

Config can wrap a viper.Viper configuration in the context

func NewConfig

func NewConfig(v *viper.Viper) *Config

func (*Config) Context

func (c *Config) Context(ctx context.Context) context.Context

func (Config) FromContext

func (c Config) FromContext(ctx context.Context) interface{}

type ContextInjectable

type ContextInjectable interface {
	// Context builds a context with the injected value
	Context(context.Context) context.Context

	// FromContext retrieves the injected value from the context.
	//
	// It should work even if the receiver is zero value.
	FromContext(context.Context) interface{}
}

ContextInjectable knows how to retrieve a value from a Context.

Users of the github.com/fredbi/go-cli/cli package can define their own injections via the context.

NOTE: every such type should declare their own key type to avoid conflicts inside the context.

For example:

type commandCtxKey uint8
const ctxConfig commandCtxKey = iota + 1

type SLogger

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

func NewSLogger

func NewSLogger(l *slog.Logger) *SLogger

func (*SLogger) Context

func (c *SLogger) Context(ctx context.Context) context.Context

func (SLogger) FromContext

func (c SLogger) FromContext(ctx context.Context) interface{}

type ZapLogger

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

func NewZapLogger

func NewZapLogger(l *zap.Logger) *ZapLogger

func (*ZapLogger) Context

func (c *ZapLogger) Context(ctx context.Context) context.Context

func (ZapLogger) FromContext

func (c ZapLogger) FromContext(ctx context.Context) interface{}