gotag

type ReadValueError ¶

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

An error that wraps the underlying value write error.

func NewReadValueError[T any](valueType reflect.Type, cause error) *ReadValueError

func (e *ReadValueError) Error() string

func (e *ReadValueError) Unwrap() error

type StructDecoder ¶

type StructDecoder[T any, S any] interface {
	// Create a new instance based on the source.
	Decode(s S) (T, error)
}

Decoder that creates new instaces of structs that have struct tags.

func NewDecoder[T any, S any](writers ...StructTagValueWriter[S]) StructDecoder[T, S]

type StructEncoder ¶

type StructEncoder[T any, R any] interface {
	// Create a new instance based on the source.
	Encode(t T, defaultValue R) (R, error)
}

Decoder that creates new instaces of structs that have struct tags.

func NewEncoder[T any, R any](readers ...StructTagValueReader[R]) StructEncoder[T, R]

type StructEncoderCombiner ¶

type StructEncoderCombiner[S any, R any] func(S, R) (R, error)

type StructTagCommand ¶

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

Allows accessing the value without exposing the reflect.Value.

func (c *StructTagCommand) Tag() string

func (c *StructTagCommand) TagValues() []string

type StructTagHandler ¶

type StructTagHandler interface {
	Tag() string
}

Interface for struct tag handlers.

type StructTagHandlerExecutionError ¶

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

An error that wraps the underlying value tag processing error.

func NewStructTagHandlerExecutionError(command *StructTagCommand, cause error) *StructTagHandlerExecutionError

func (e *StructTagHandlerExecutionError) Error() string

func (e *StructTagHandlerExecutionError) Unwrap() error

type StructTagHandlerUnsupportedFieldError ¶

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

An error for a not supported field.

func NewStructTagHandlerUnsupportedFieldError(command *StructTagCommand) *StructTagHandlerUnsupportedFieldError

func (e *StructTagHandlerUnsupportedFieldError) Error() string

type StructTagValueReader ¶

type StructTagValueReader[R any] interface {
	StructTagHandler
	// Processes the struct tag and sets the value.
	Read(cmd *StructTagCommand, result R) (R, error)
}

Interface for struct tag based value writers.

type StructTagValueWriter ¶

type StructTagValueWriter[S any] interface {
	StructTagHandler
	// Processes the struct tag and sets the value.
	Write(cmd *StructTagCommand, source S) error
}

Interface for struct tag based value writers.

type TagValueHandlerConfigError ¶

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

An error for a invalid handler configuration.

func NewTagValueHandlerConfigError(command *StructTagCommand, message string) *TagValueHandlerConfigError

func (e *TagValueHandlerConfigError) Error() string

type ValueReaderFunc ¶

type ValueReaderFunc[R any] func(value reflect.Value) (R, bool, error)

Function that transforms the reflect.Value. Returns value, true and nil error, if the execution has succeeded. Returns default value, true and non-nil error, if the execution has failed. Returns default value, false and nil error, if the value is not supported.

func NewFirstSucceedValueReader[R any](readers ...ValueReaderFunc[R]) ValueReaderFunc[R]

func NewFirstSupportedValueReader[R any](readers ...ValueReaderFunc[R]) ValueReaderFunc[R]

func (f ValueReaderFunc[R]) ReadValue(c *StructTagCommand) (R, error)

type ValueWriterFunc ¶

type ValueWriterFunc[S any] func(value reflect.Value, source S) (bool, error)

Function that transforms the source value, and writes it to the reflect.Value. Returns true and nil error, if the execution has succeeded. Returns true and non-nil error, if the execution has failed. Returns false and nil error, if the value is not supported.

func NewFirstSucceedValueWriter[S any](writers ...ValueWriterFunc[S]) ValueWriterFunc[S]

func NewFirstSupportedValueWriter[S any](writers ...ValueWriterFunc[S]) ValueWriterFunc[S]

func (f ValueWriterFunc[S]) WriteValue(c *StructTagCommand, source S) error

type WriteValueError ¶

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

An error that wraps the underlying value write error.

func NewWriteValueError(newValue any, valueType reflect.Type, cause error) *WriteValueError

func (e *WriteValueError) Error() string

func (e *WriteValueError) Unwrap() error