config

package

v0.35.1 Latest Latest Go to latest Published: Apr 9, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cerbos/cerbos

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Get(key string, out any) error
func GetSection(section Section) error
func Load(confFile string, overrides map[string]any) error
func LoadMap(m map[string]any) error
func LoadReader(reader io.Reader, overrides map[string]any) error
type Defaulter
type Section
type Validator
type Wrapper
- func (w *Wrapper) Get(key string, out any) error
- func (w *Wrapper) GetSection(section Section) error

Constants ¶

View Source

const DefaultMarker = "__default__"

Variables ¶

View Source

var ErrConfigNotLoaded = errors.New("config not loaded")

Functions ¶

func Get ¶

func Get(key string, out any) error

Get populates out with the configuration at the given key. Populate out with default values before calling this function to ensure sane defaults if there are any.

func GetSection ¶

func GetSection(section Section) error

GetSection populates a config section.

func Load ¶

func Load(confFile string, overrides map[string]any) error

Load loads the config file at the given path.

func LoadMap ¶

func LoadMap(m map[string]any) error

func LoadReader ¶

func LoadReader(reader io.Reader, overrides map[string]any) error

Types ¶

type Defaulter ¶

type Defaulter interface {
	SetDefaults()
}

type Section ¶

type Section interface {
	Key() string
}

type Validator ¶

type Validator interface {
	Validate() error
}

type Wrapper ¶ added in v0.15.0

type Wrapper struct {
	// contains filtered or unexported fields
}

func Global ¶ added in v0.15.0

func Global() *Wrapper

Global returns the default global config wrapper.

func WrapperFromMap ¶ added in v0.15.0

func WrapperFromMap(m map[string]any) (*Wrapper, error)

func WrapperFromReader ¶ added in v0.15.0

func WrapperFromReader(reader io.Reader, overrides map[string]any) (*Wrapper, error)

func (*Wrapper) Get ¶ added in v0.15.0

func (w *Wrapper) Get(key string, out any) error

func (*Wrapper) GetSection ¶ added in v0.15.0

func (w *Wrapper) GetSection(section Section) error

Source Files ¶

View all Source files

config.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL