options

Documentation

Overview

Package options provides a way to pass unstructured sets of options to a component expecting a strongly-typed configuration structure.

Index

• func GenerateFromModel(options Generic, model interface{}) (interface{}, error)
• type CannotSetFieldError
  • func (e CannotSetFieldError) Error() string
• type Generic
  • func NewGeneric() Generic
• type NoSuchFieldError
  • func (e NoSuchFieldError) Error() string
• type TypeMismatchError
  • func (e TypeMismatchError) Error() string

Functions

func GenerateFromModel

func GenerateFromModel(options Generic, model interface{}) (interface{}, error)

GenerateFromModel takes the generic options, and tries to build a new instance of the model's type by matching keys from the generic options to fields in the model.

The return value is of the same type than the model (including a potential pointer qualifier).

Types

type CannotSetFieldError

type CannotSetFieldError struct {
	Field string
	Type  string
}

CannotSetFieldError is the error returned when the generic parameters hold a value for a field that cannot be set in the destination structure.

func (CannotSetFieldError) Error

func (e CannotSetFieldError) Error() string

type Generic

type Generic map[string]interface{}

Generic is an basic type to store arbitrary settings.

func NewGeneric

func NewGeneric() Generic

NewGeneric returns a new Generic instance.

type NoSuchFieldError

type NoSuchFieldError struct {
	Field string
	Type  string
}

NoSuchFieldError is the error returned when the generic parameters hold a value for a field absent from the destination structure.

func (NoSuchFieldError) Error

func (e NoSuchFieldError) Error() string

type TypeMismatchError

type TypeMismatchError struct {
	Field      string
	ExpectType string
	ActualType string
}

TypeMismatchError is the error returned when the type of the generic value for a field mismatches the type of the destination structure.

func (TypeMismatchError) Error

func (e TypeMismatchError) Error() string