simple

Documentation

Overview

Package simple allows for structured, but schema-less values to be represented while constraining the possible types to a limited, knowable set.

Index

• type Array
  • func (a Array) String() string
  • func (a *Array) UnmarshalJSON(data []byte) error
• type Bool
  • func (b Bool) String() string
• type Number
  • func (n Number) String() string
• type String
  • func (s String) String() string
• type Struct
  • func (s Struct) String() string
  • func (s *Struct) UnmarshalJSON(data []byte) error
• type Value
  • func FromJSON(jb json.RawMessage) (Value, error)
  • func FromValue(v any) (Value, error)

Types

type Array

type Array []Value

Array is an ordered set of Value values

func (Array) String

func (a Array) String() string

String implements Value

func (*Array) UnmarshalJSON

func (a *Array) UnmarshalJSON(data []byte) error

type Bool

type Bool bool

Bool is true of false

func (Bool) String

func (b Bool) String() string

String implements Value

type Number

type Number float64

Number is some numeric value. IEEE754 floating point number.

func (Number) String

func (n Number) String() string

String implements Value

type String

type String string

String is an ordered set of UTF-8 characters.

func (String) String

func (s String) String() string

String implements Value

type Struct

type Struct map[string]Value

Struct is a key value structure where keys are strings the are mapped to a Value

func (Struct) String

func (s Struct) String() string

String implements Value

func (*Struct) UnmarshalJSON

func (s *Struct) UnmarshalJSON(data []byte) error

type Value

type Value interface {
	String() string
	// contains filtered or unexported methods
}

Value is a way of having structured data with no specific schema. It mirrors JSON's limited type set. So, Value can only be one of the following: Struct, Array, Number, String, Bool. JSON "null" can be represented by Go's nil.

func FromJSON

func FromJSON(jb json.RawMessage) (Value, error)

FromJSON will instantiate a Value based on JSON. The only possible failure is JSON syntax errors.

func FromValue

func FromValue(v any) (Value, error)

FromValue allows any scalar or composite value to be simplified to a Value.

Things like channels, functions and interfaces do not represent transmittable values and therefore cannot be simplified.

Any value that implements `SimpleValue() (Value, error)` or `SimpleValue() Value` can override some logic and handle value simplification on their own.