config

Documentation

Index

• Constants
• func AuthorizerFromInterface[T Authorizer](f any, authSelectFn AuthorizerSelectorFn[T]) (T, error)
• func GetInterfaceValue[T any](fmap map[string]interface{}, key string) (T, error)
• type Authorizer
• type AuthorizerSelectorFn
• type Config
• type KeyedConfig
• type KeyedConfigWatcher

Constants

const AuthorizerTypeProperty = "authorizerType"

AuthorizerTypeProperty is the property where the id of an Authorizer should be placed in its custom MarshalJSON function

const Redacted = "REDACTED"

Functions

func AuthorizerFromInterface

func AuthorizerFromInterface[T Authorizer](f any, authSelectFn AuthorizerSelectorFn[T]) (T, error)

AuthorizerFromInterface this generic function provides Authorizer unmarshalling for all providers

func GetInterfaceValue

func GetInterfaceValue[T any](fmap map[string]interface{}, key string) (T, error)

Types

type Authorizer

type Authorizer interface {
	Config
	json.Marshaler
}

type AuthorizerSelectorFn

type AuthorizerSelectorFn[T Authorizer] func(string) (T, error)

AuthorizerSelectorFn implementations of this function should be a simple switch and acts as a register for the Authorizer types, returned Authorizer should be empty except for its default type property and will have other values marshalled into it

type Config

type Config interface {
	Validate() error
	Sanitize() Config
	Equals(Config) bool
}

Config allows for nested configurations which encapsulate their functionality to be validated and compared easily

type KeyedConfig

type KeyedConfig interface {
	Config
	Key() string
}

KeyedConfig is a top level Config which uses its public values as a unique identifier allowing duplicates to be identified

type KeyedConfigWatcher

type KeyedConfigWatcher interface {
	GetConfigs() []KeyedConfig
}