apijson

Documentation

Index

• func Marshal(value interface{}) ([]byte, error)
• func MarshalRoot(value interface{}) ([]byte, error)
• func Port(from any, to any) error
• func RegisterDiscriminatedUnion[T any](key string, mappings map[string]reflect.Type)
• func RegisterFieldValidator[T any, V string | bool | int](fieldName string, nullable bool, values ...V)
• func RegisterUnion[T any](discriminator string, variants ...UnionVariant)
• func Unmarshal(raw []byte, to any) error
• func UnmarshalRoot(raw []byte, to any) error
• type Field
  • func (j Field) IsInvalid() bool
  • func (j Field) IsMissing() bool
  • func (j Field) IsNull() bool
  • func (j Field) Raw() string
• type UnionUnmarshaler
  • func (c *UnionUnmarshaler[T]) UnmarshalJSON(buf []byte) error
• type UnionVariant

Functions

func Marshal

func Marshal(value interface{}) ([]byte, error)

func MarshalRoot

func MarshalRoot(value interface{}) ([]byte, error)

func Port

func Port(from any, to any) error

Port copies over values from one struct to another struct.

func RegisterDiscriminatedUnion

func RegisterDiscriminatedUnion[T any](key string, mappings map[string]reflect.Type)

func RegisterFieldValidator

func RegisterFieldValidator[T any, V string | bool | int](fieldName string, nullable bool, values ...V)

func RegisterUnion

func RegisterUnion[T any](discriminator string, variants ...UnionVariant)

func Unmarshal

func Unmarshal(raw []byte, to any) error

Unmarshal is similar to encoding/json.Unmarshal and parses the JSON-encoded data and stores it in the given pointer.

func UnmarshalRoot

func UnmarshalRoot(raw []byte, to any) error

UnmarshalRoot is like Unmarshal, but doesn't try to call MarshalJSON on the root element. Useful if a struct's UnmarshalJSON is overrode to use the behavior of this encoder versus the standard library.

Types

type Field

type Field struct {
	// contains filtered or unexported fields
}

func (Field) IsInvalid

func (j Field) IsInvalid() bool

func (Field) IsMissing

func (j Field) IsMissing() bool

func (Field) IsNull

func (j Field) IsNull() bool

Returns true if the field is explicitly `null` _or_ if it is not present at all (ie, missing). To check if the field's key is present in the JSON with an explicit null value, you must check `f.IsNull() && !f.IsMissing()`.

func (Field) Raw

func (j Field) Raw() string

type UnionUnmarshaler

type UnionUnmarshaler[T any] struct {
	Value T
}

Useful to wrap a union type to force it to use apijson.UnmarshalJSON since you cannot define an UnmarshalJSON function on the interface itself.

func (*UnionUnmarshaler[T]) UnmarshalJSON

func (c *UnionUnmarshaler[T]) UnmarshalJSON(buf []byte) error

type UnionVariant

type UnionVariant struct {
	TypeFilter         gjson.Type
	DiscriminatorValue interface{}
	Type               reflect.Type
}