shared

Documentation

Index

• type Dict
• type Driver
• type Parser
  • func LookupParser(fieldType reflect.Type) *Parser
• type UnmarshalDict
• type Value

Types

type Dict

type Dict interface {
	Lookup(key string) (Value, bool)
	AsValue() Value
	Keys() []string
}

A dictionary.

We use this type instead of raw type conversions to decrease the risk of confusion whenever manipulating `any` and to allow us to work with cases in which we do not have direct access to a dictionary.

type Driver

type Driver interface {
	// Return true if we have a specific implementation of deserialization
	// for a given type, for instance, if that type implements a specific
	// deserialization interface.
	ShouldUnmarshal(reflect.Type) bool

	// Perform unmarshaling for a value.
	Unmarshal(any, *any) error

	// Wrap a basic value as a `Value`.
	WrapValue(any) Value
}

A driver for a specific type of deserialization.

type Parser

type Parser func(source string) (any, error)

A parser for strings into primitive values.

func LookupParser

func LookupParser(fieldType reflect.Type) *Parser

type UnmarshalDict

type UnmarshalDict interface {
	UnmarshalDict(Dict) error
}

A type that can be deserialized from a shared.Dict.

type Value

type Value interface {
	AsDict() (Dict, bool)
	AsSlice() ([]Value, bool)
	Interface() any
}

A value in a dictionary.

We use this type instead of raw type conversions to decrease the risk of confusion whenever manipulating `any` and to allow us to work with cases in which we do not have direct access to a dictionary.