options

Documentation

Index

• Variables
• func Apply(src interface{}, opts ...Option) error
• func NewOption(name string) func(...interface{}) Option
• func SetValueByPath(src interface{}, dst interface{}, path string) error
• type Hook
• type Hooks
  • func (hs *Hooks) Append(h ...Hook)
  • func (hs *Hooks) EachNext(fn func(Hook))
  • func (hs *Hooks) EachPrev(fn func(Hook))
  • func (hs *Hooks) Replace(h ...Hook)
• type Option
• type Validator

Variables

var (
	Address   = NewOption("Address")
	Name      = NewOption("Name")
	Broker    = NewOption("Broker")
	Logger    = NewOption("Logger")
	Meter     = NewOption("Meter")
	Tracer    = NewOption("Tracer")
	Store     = NewOption("Store")
	Register  = NewOption("Register")
	Router    = NewOption("Router")
	Codec     = NewOption("Codec")
	Codecs    = NewOption("Codecs")
	Client    = NewOption("Client")
	Context   = NewOption("Context")
	TLSConfig = NewOption("TLSConfig")
	Metadata  = NewOption("Metadata")
	Timeout   = NewOption("Timeout")
)

Functions

func Apply

func Apply(src interface{}, opts ...Option) error

Apply assign options to struct src

func NewOption

func NewOption(name string) func(...interface{}) Option

NewOption create new option with name

func SetValueByPath

func SetValueByPath(src interface{}, dst interface{}, path string) error

SetValueByPath set src struct field to val dst via path

Types

type Hook

type Hook interface{}

Hook func interface

type Hooks

type Hooks []Hook

Hooks func slice

func (*Hooks) Append

func (hs *Hooks) Append(h ...Hook)

Append is used to add hooks

func (*Hooks) EachNext

func (hs *Hooks) EachNext(fn func(Hook))

EachNext is used to itearate over hooks forward

func (*Hooks) EachPrev

func (hs *Hooks) EachPrev(fn func(Hook))

EachPrev is used to iterate over hooks backward

func (*Hooks) Replace

func (hs *Hooks) Replace(h ...Hook)

Replace is used to set hooks

type Option

type Option func(interface{}) error

Option func signature

type Validator

type Validator interface {
	// Validate returns nil, if all options are correct,
	// otherwise returns an error explaining the mistake
	Validate() error
}

Options interface must be used by all options