conf

Documentation

Overview

Package conf contains alias for map encoded configuration and structure unmarshaller

Index

• Constants
• Variables
• type MapConfig
  • func (m MapConfig) MarshalZerologObject(e *zerolog.Event)
  • func (m MapConfig) Unmarshal(into any) (err error)
• type NamedMapConfig
  • func (nm NamedMapConfig) MarshalZerologObject(e *zerolog.Event)

Constants

const TagName = "cfg"

TagName is a tag name, used for decoder customization

Variables

var ErrNilConfigMap = errors.New("unable to process nil map")

ErrNilConfigMap returned if unmarshalling map is nil and could not be decoded into structure

Types

type MapConfig

type MapConfig map[string]any

MapConfig is just alias for map[string]any

func (MapConfig) MarshalZerologObject

func (m MapConfig) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject writes map into zerolog event

func (MapConfig) Unmarshal

func (m MapConfig) Unmarshal(into any) (err error)

Unmarshal decodes receiver map into provided structure. Decoder configured to automatically unmarshal inherited structures, convert string-ed duration (1s, 2m, 3h...) into time.Duration and string representation IP into net.IP. Tag used for decode customization is conf.TagName.

type NamedMapConfig

type NamedMapConfig struct {
	Name   string
	Config MapConfig
}

NamedMapConfig encapsulates MapConfig with string Name

func (NamedMapConfig) MarshalZerologObject

func (nm NamedMapConfig) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject writes Name and Config into zerolog event