plugins

Documentation

Overview

Package plugins describes the xconfig provider interface. it exists to enable xconfig.Classic without circular deps.

Index

• Variables
• func RegisterTag(name string)
• type Plugin
• type Visitor
• type Walker

Variables

var ErrUsage = errors.New("xconfig: usage request")

ErrUsage is returned when user has request usage message via some plugin, mostly flags.

Functions

func RegisterTag

func RegisterTag(name string)

RegisterTag allows providers to ensure their tag is unique. they must call this function from an init.

Types

type Plugin

type Plugin interface {
	Parse() error
}

Plugin is the common interface for all xconfig providers.

type Visitor

type Visitor interface {
	Plugin

	Visit(fields flat.Fields) error
}

Visitor is the interface for providers that require a flat view of the config, like flags, env vars.

type Walker

type Walker interface {
	Plugin

	Walk(config any) error
}

Walker is the interface for providers that take the whole config, like file loaders.