stick

Documentation

Index

• func Backoff(min, max time.Duration, factor float64, attempt int) time.Duration
• func Contains(list []string, str string) bool
• func Get(acc Accessible, name string) (interface{}, bool)
• func GetBSONKey(field *reflect.StructField) string
• func GetJSONKey(field *reflect.StructField) string
• func Includes(all, subset []string) bool
• func Intersect(listA, listB []string) []string
• func MustGet(acc Accessible, name string) interface{}
• func MustSet(acc Accessible, name string, value interface{})
• func Set(acc Accessible, name string, value interface{}) bool
• func Union(listA, listB []string) []string
• func Unique(list []string) []string
• type Accessible
• type Accessor
  • func BuildAccessor(v interface{}, ignore ...string) *Accessor
• type Coding
  • func (c Coding) Marshal(in interface{}) ([]byte, error)
  • func (c Coding) Transfer(in, out interface{}) error
  • func (c Coding) Unmarshal(in []byte, out interface{}) error
• type Field
• type Map
  • func MustMap(from interface{}, coding Coding) Map
  • func (m *Map) Marshal(from interface{}, coding Coding) error
  • func (m *Map) MustMarshal(from interface{}, coding Coding)
  • func (m *Map) MustUnmarshal(to interface{}, coding Coding)
  • func (m *Map) Unmarshal(to interface{}, coding Coding) error
• type NoValidation
  • func (*NoValidation) Validate() error

Functions

func Backoff

func Backoff(min, max time.Duration, factor float64, attempt int) time.Duration

Backoff will calculate the exponential delay.

func Contains

func Contains(list []string, str string) bool

Contains return whether the list contains the item.

func Get

func Get(acc Accessible, name string) (interface{}, bool)

Get will lookup the specified field on the accessible and return its value and whether the field was found at all.

func GetBSONKey

func GetBSONKey(field *reflect.StructField) string

GetBSONKey will return the BSON key for the specified struct field.

func GetJSONKey

func GetJSONKey(field *reflect.StructField) string

GetJSONKey will return the JSON key for the specified struct field.

func Includes

func Includes(all, subset []string) bool

Includes returns whether a list includes another list.

func Intersect

func Intersect(listA, listB []string) []string

Intersect will return the intersection of two lists.

func MustGet

func MustGet(acc Accessible, name string) interface{}

MustGet will call Get and panic if the operation failed.

func MustSet

func MustSet(acc Accessible, name string, value interface{})

MustSet will call Set and panic if the operation failed.

func Set

func Set(acc Accessible, name string, value interface{}) bool

Set will set the specified field on the accessible with the provided value and return whether the field has been found and the value has been set.

func Union

func Union(listA, listB []string) []string

Union will will merge two lists and remove duplicates.

func Unique

func Unique(list []string) []string

Unique will return a new list with unique strings.

Types

type Accessible

type Accessible interface {
	GetAccessor(interface{}) *Accessor
}

Accessible is a type that has dynamically accessible fields.

type Accessor

type Accessor struct {
	Name   string
	Fields map[string]*Field
}

Accessor provides dynamic access to a structs fields.

func BuildAccessor

func BuildAccessor(v interface{}, ignore ...string) *Accessor

BuildAccessor will build an accessor for the provided type.

type Coding

type Coding string

Coding defines an encoding, decoding and transfer scheme.

const (
	JSON Coding = "json"
	BSON Coding = "bson"
)

The available coding schemes.

func (Coding) Marshal

func (c Coding) Marshal(in interface{}) ([]byte, error)

Marshal will encode the specified value into a byte sequence.

func (Coding) Transfer

func (c Coding) Transfer(in, out interface{}) error

Transfer will transfer data from one value to another using.

func (Coding) Unmarshal

func (c Coding) Unmarshal(in []byte, out interface{}) error

Unmarshal will decode the specified value from the provided byte sequence.

type Field

type Field struct {
	Index int
	Type  reflect.Type
}

Field is dynamically accessible field.

type Map

type Map map[string]interface{}

Map represents a simple map. It provides methods to marshal and unmarshal concrete types to and from the map using JSON or BSON coding.

func MustMap

func MustMap(from interface{}, coding Coding) Map

MustMap will marshal the specified object to a map and panic on any error.

func (*Map) Marshal

func (m *Map) Marshal(from interface{}, coding Coding) error

Marshal will marshal the specified value to the map. If the map already contains data, only fields present in the value are overwritten.

func (*Map) MustMarshal

func (m *Map) MustMarshal(from interface{}, coding Coding)

MustMarshal will marshal and panic on error.

func (*Map) MustUnmarshal

func (m *Map) MustUnmarshal(to interface{}, coding Coding)

MustUnmarshal will unmarshal and panic on error.

func (*Map) Unmarshal

func (m *Map) Unmarshal(to interface{}, coding Coding) error

Unmarshal will unmarshal the map to the specified value. If the value already contains data, only fields present in the map are overwritten.

type NoValidation

type NoValidation struct{}

NoValidation can be embedded in a struct to provide a no-op validation method.

func (*NoValidation) Validate

func (*NoValidation) Validate() error

Validate will perform no validation.