config

Documentation

Overview

Package config manages server configuration.

Index

• type Config
  • func Default() Config
  • func Map(conf map[string]map[string]string) Config
• type Writer

Types

type Config

type Config interface {
	All(context.Context) (map[string]map[string]string, error)
	Section(context.Context, string) (map[string]string, error)
	Key(context.Context, string, string) (string, error)
	Reload(context.Context) error
}

Config provides access to read server configuration. Configuration backends that allow modifying configuration will also implement [ConfigWriter].

func Default

func Default() Config

Default returns a Config implementation which returns default values for all configuration options, and preserves changed settings only until restart.

func Map

func Map(conf map[string]map[string]string) Config

Map returns a Config implementation which returns the provided configuration.

type Writer

type Writer interface {
	// SetKey sets a new config value, and returns the old value.
	SetKey(context.Context, string, string, string) (string, error)
	Delete(context.Context, string, string) (string, error)
}

Writer allows setting server configuration.