package
0.21.6
Repository: https://github.com/neuronlabs/neuron.git
Documentation: pkg.go.dev

# Functions

ExtractFieldAnnotations extracts codec specific tags.
MarshalSingleModel marshals the output with single model encoding type.
MarshalWithLinks marshals the output with provided links.
UnmarshalStrictly is an unmarshal option that sets up option to strictly check the fields when unmarshaled the fields.
UnmarshalWithModel is an unmarshal option that sets up model that should be unmarshaled.
UnmarshalWithModelStruct is an unmarshal option that sets up model struct that should be unmarshaled.
UnmarshalWithSingleExpectation is an unmarshal option that sets up the single model unmarshal expectation.

# Constants

ISO8601TimeFormat is the time formatting for the ISO 8601.
Link type enumerators.
Link type enumerators.
Link type enumerators.
Link type enumerators.
StructTag is a constant used as a tag that defines models codecs.

# Variables

ErrCodec is a general codec error.
ErrMarshal is an error with marshaling.
ErrMarshalPayload is an error of marshaling payload.
ErrOptions is an error that defines invalid marshal/unmarshal options.
ErrUnmarshal is an error related to unmarshaling process.
ErrUnmarshalDocument is an error related to unmarshaling invalid document,.
ErrUnmarshalFieldName is an error related t unmarshaling field name.
ErrUnmarshalFieldValue is an error related to unmarshaling field value.

# Structs

Error is the error structure used for used for codec processes.
FieldAnnotations is structure that is extracted from the given sField codec specific annotation.
LinkOptions contains link options required for marshaling codec data.
MarshalOptions is a structure that contains marshaling information.
PaginationLinks is the structure that contain options for the pagination links.
Payload is the default structure used by codecs to marshal and unmarshal.
UnmarshalOptions is the structure that contains unmarshal options.

# Interfaces

Codec is an interface used to marshal and unmarshal data, payload and errors in some encoding type.
ModelMarshaler is an interface that allows to marshal provided models.
ModelUnmarshaler is an interface that allows to unmarshal provided models of given model struct.
PayloadMarshaler is the interface used to marshal payload into provided writer..
PayloadUnmarshaler is the interface used to unmarshal payload from given reader for provided codec type.

# Type aliases

LinkType is the link type used for marshaling.
MarshalOption is the option function that sets up the marshal options.
Meta is used to represent a `meta` object.
MultiError is an error composed of multiple single errors.
UnmarshalOption is function that changes unmarshal options.