config

Documentation

Index

• Variables
• func DurationCustomTypeFunc(field reflect.Value) interface{}
• type Duration
  • func (d Duration) MarshalJSON() ([]byte, error)
  • func (d *Duration) UnmarshalJSON(b []byte) error
  • func (d *Duration) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var ErrDurationMustBeString = errors.New("cannot JSON unmarshal something other than a string into a ConfigDuration")

ErrDurationMustBeString is returned when a non-string value is presented to be deserialized as a ConfigDuration

Functions

func DurationCustomTypeFunc

func DurationCustomTypeFunc(field reflect.Value) interface{}

DurationCustomTypeFunc enables registration of our custom config.Duration type as a time.Duration and performing validation on the configured value using the standard suite of validation functions.

Types

type Duration

type Duration struct {
	time.Duration `validate:"required"`
}

Duration is custom type embedding a time.Duration which allows defining methods such as serialization to YAML or JSON.

func (Duration) MarshalJSON

func (d Duration) MarshalJSON() ([]byte, error)

MarshalJSON returns the string form of the duration, as a byte array.

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(b []byte) error

UnmarshalJSON parses a string into a ConfigDuration using time.ParseDuration. If the input does not unmarshal as a string, then UnmarshalJSON returns ErrDurationMustBeString.

func (*Duration) UnmarshalYAML

func (d *Duration) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML uses the same format as JSON, but is called by the YAML parser (vs. the JSON parser).