contextx

Documentation

Index

• Variables
• func ConfigFromContext(ctx context.Context) (*configx.Provider, error)
• func IsRootContext(ctx context.Context) bool
• func MustConfigFromContext(ctx context.Context) *configx.Provider
• func SetNIDContext(ctx context.Context, nid uuid.UUID) context.Context
• func WithConfig(ctx context.Context, p *configx.Provider) context.Context
• type ContextKey
• type Contextualizer
• type Default
  • func (d *Default) Config(ctx context.Context, config *configx.Provider) *configx.Provider
  • func (d *Default) Network(ctx context.Context, network uuid.UUID) uuid.UUID
• type NoOp
  • func (d *NoOp) Config(ctx context.Context, config *configx.Provider) *configx.Provider
  • func (d *NoOp) Network(ctx context.Context, network uuid.UUID) uuid.UUID
• type Provider
• type Static
  • func (d *Static) Config(ctx context.Context, config *configx.Provider) *configx.Provider
  • func (d *Static) Network(ctx context.Context, network uuid.UUID) uuid.UUID
• type TestContextualizer
  • func (d *TestContextualizer) Config(ctx context.Context, config *configx.Provider) *configx.Provider
  • func (d *TestContextualizer) Network(ctx context.Context, network uuid.UUID) uuid.UUID

Examples

• ConfigFromContext

Variables

var ErrNoConfigInContext = errors.New("configuration provider not found in context")

ErrNoConfigInContext is returned when no config is found in the context.

var RootContext = context.WithValue(context.Background(), ValidContextKey, true)

Functions

func ConfigFromContext

func ConfigFromContext(ctx context.Context) (*configx.Provider, error)

ConfigFromContext returns the configuration provider from the context or an error if no configuration provider is found in the context.

Example

ctx := context.Background()

config, err := configx.New(ctx, []byte(`{"type":"object","properties":{"foo":{"type":"string"}}}`), configx.WithValue("foo", "bar"))
if err != nil {
	panic(err)
}

ctx = WithConfig(ctx, config)
fmt.Printf("foo = %s", MustConfigFromContext(ctx).String("foo"))

Output:

foo = bar

func IsRootContext

func IsRootContext(ctx context.Context) bool

func MustConfigFromContext

func MustConfigFromContext(ctx context.Context) *configx.Provider

MustConfigFromContext returns the configuration provider from the context or panics if no configuration provider is found in the context.

func SetNIDContext

func SetNIDContext(ctx context.Context, nid uuid.UUID) context.Context

SetNIDContext sets the nid for the given context.

func WithConfig

func WithConfig(ctx context.Context, p *configx.Provider) context.Context

WithConfig returns a new context with the given configuration provider.

Types

type ContextKey

type ContextKey int

const (
	ValidContextKey ContextKey = iota + 1
)

type Contextualizer

type Contextualizer interface {
	// Network returns the network id for the given context.
	Network(ctx context.Context, network uuid.UUID) uuid.UUID

	// Config returns the config for the given context.
	Config(ctx context.Context, config *configx.Provider) *configx.Provider
}

type Default

type Default struct{}

func (*Default) Config

func (d *Default) Config(ctx context.Context, config *configx.Provider) *configx.Provider

func (*Default) Network

func (d *Default) Network(ctx context.Context, network uuid.UUID) uuid.UUID

type NoOp

type NoOp struct{}

func (*NoOp) Config

func (d *NoOp) Config(ctx context.Context, config *configx.Provider) *configx.Provider

func (*NoOp) Network

func (d *NoOp) Network(ctx context.Context, network uuid.UUID) uuid.UUID

type Provider

type Provider interface {
	Contextualizer() Contextualizer
}

type Static

type Static struct {
	NID uuid.UUID
	C   *configx.Provider
}

func (*Static) Config

func (d *Static) Config(ctx context.Context, config *configx.Provider) *configx.Provider

func (*Static) Network

func (d *Static) Network(ctx context.Context, network uuid.UUID) uuid.UUID

type TestContextualizer

type TestContextualizer struct{}

TestContextualizer is a mock implementation of the Contextualizer interface.

func (*TestContextualizer) Config

func (d *TestContextualizer) Config(ctx context.Context, config *configx.Provider) *configx.Provider

Config returns the config for the given context.

func (*TestContextualizer) Network

func (d *TestContextualizer) Network(ctx context.Context, network uuid.UUID) uuid.UUID

Network returns the network id for the given context.