options

Documentation

Index

• type Option
• type Options
  • func Join[T any, O Option[T]](opts []O) Options[T, O]
  • func (o Options[T, _]) Apply(opts T) error
  • func (o Options[_, _]) LogAttr() slog.Attr
  • func (o Options[T, O]) LogValue() slog.Value

Types

type Option

type Option[T any] interface {
	Apply(opts T) error
	LogAttr() slog.Attr
}

Option is a single functional option.

type Options

type Options[T any, O Option[T]] []O

Options is a collection of functional Options.

func Join

func Join[T any, O Option[T]](opts []O) Options[T, O]

Join creates a new Option joining the provided Option values.

The result implements slog.LogValuer, so the following is evaluated lazily:

slog.LogAttrs(ctx, slog.LevelInfo, "settings", Join(opts...).LogAttr())

func (Options[T, _]) Apply

func (o Options[T, _]) Apply(opts T) error

Apply applies each Option in the list.

func (Options[_, _]) LogAttr

func (o Options[_, _]) LogAttr() slog.Attr

LogAttr returns a lazy slog.Attr for logging.

func (Options[T, O]) LogValue

func (o Options[T, O]) LogValue() slog.Value

LogValue implements slog.LogValuer.