serializer

Documentation

Index

• func NotEmpty(value interface{}) error
• func Positive(value interface{}) error
• func ValidEmail(value interface{}) error
• func ValidPassword(value interface{}) error
• type BaseSerializer
  • func (s *BaseSerializer) Deserialize(input map[string]interface{}, out interface{}) error
  • func (s *BaseSerializer) Serialize(data interface{}) (map[string]interface{}, error)
  • func (s *BaseSerializer) SerializeToXML(data interface{}) (string, error)
  • func (s *BaseSerializer) SerializeToYAML(data interface{}) (string, error)
  • func (s *BaseSerializer) Validate(data map[string]interface{}) error
• type Field
• type SerializationError
  • func (e *SerializationError) Error() string
• type Serializer
• type StringField
  • func (f StringField) Validate(value interface{}) error
• type TransformationError
  • func (e *TransformationError) Error() string
• type ValidationError
  • func (e *ValidationError) Error() string

Functions

func NotEmpty

func NotEmpty(value interface{}) error

NotEmpty checks if a field is not empty.

func Positive

func Positive(value interface{}) error

Positive checks if a field is a positive number.

func ValidEmail

func ValidEmail(value interface{}) error

ValidEmail checks if a string is in a valid email format.

func ValidPassword

func ValidPassword(value interface{}) error

ValidPassword checks if a password meets certain criteria.

Types

type BaseSerializer

type BaseSerializer struct {
	Fields            []string                                     // Included fields
	Validations       map[string][]func(interface{}) error         // Multiple validations per field
	Transformations   map[string]func(interface{}) interface{}     // Transformations by field
	ConditionalFields map[string]func(map[string]interface{}) bool // Conditional inclusion of fields
}

BaseSerializer is the default implementation of Serializer.

func (*BaseSerializer) Deserialize

func (s *BaseSerializer) Deserialize(input map[string]interface{}, out interface{}) error

Deserialize deserializes a map into a struct.

func (*BaseSerializer) Serialize

func (s *BaseSerializer) Serialize(data interface{}) (map[string]interface{}, error)

Serialize serializes a struct into a map with optional field filtering, transformations, and conditional fields.

func (*BaseSerializer) SerializeToXML

func (s *BaseSerializer) SerializeToXML(data interface{}) (string, error)

SerializeToXML serializes a struct into an XML string.

func (*BaseSerializer) SerializeToYAML

func (s *BaseSerializer) SerializeToYAML(data interface{}) (string, error)

SerializeToYAML serializes a struct into a YAML string.

func (*BaseSerializer) Validate

func (s *BaseSerializer) Validate(data map[string]interface{}) error

Validate checks the provided data against the validations defined in the serializer.

type Field

type Field interface {
	Validate(value interface{}) error
}

Field interface for validating field values.

type SerializationError

type SerializationError struct {
	Message string
}

SerializationError represents an error that occurred during serialization or deserialization.

func (*SerializationError) Error

func (e *SerializationError) Error() string

type Serializer

type Serializer interface {
	Serialize(interface{}) (map[string]interface{}, error)
	Deserialize(map[string]interface{}, interface{}) error
	Validate(map[string]interface{}) error
	SerializeToXML(interface{}) (string, error)
	SerializeToYAML(interface{}) (string, error)
}

Serializer interface defines the methods for serialization.

type StringField

type StringField struct {
	MaxLength int
}

StringField represents a string with validation options.

func (StringField) Validate

func (f StringField) Validate(value interface{}) error

type TransformationError

type TransformationError struct {
	Field   string
	Value   interface{}
	Message string
}

TransformationError represents an error that occurred during a transformation.

func (*TransformationError) Error

func (e *TransformationError) Error() string

type ValidationError

type ValidationError struct {
	Field   string
	Value   interface{}
	Message string
}

ValidationError represents an error that occurred during validation.

func (*ValidationError) Error

func (e *ValidationError) Error() string