dynconfig

Documentation

Index

• Constants
• type DecoderConfigOption
• type Dynconfig
  • func New(client ManagerClient, cachePath string, expire time.Duration) (Dynconfig, error)
• type ManagerClient
• type SourceType

Constants

const (
	// CacheDirName is dir name of dynconfig cache.
	CacheDirName = "dynconfig"
)

Types

type DecoderConfigOption

type DecoderConfigOption func(*mapstructure.DecoderConfig)

A DecoderConfigOption can be passed to dynconfig Unmarshal to configure mapstructure.DecoderConfig options.

type Dynconfig

type Dynconfig interface {
	// Unmarshal unmarshals the config into a Struct. Make sure that the tags
	// on the fields of the structure are properly set.
	Unmarshal(rawVal any) error

	// Refresh refreshes dynconfig in cache.
	Refresh() error
}

func New

func New(client ManagerClient, cachePath string, expire time.Duration) (Dynconfig, error)

New returns a new dynconfig instance.

type ManagerClient

type ManagerClient interface {
	Get() (any, error)
}

managerClient is a client of manager.

type SourceType

type SourceType string