fields

Documentation

Index

• func StaticValue[Model any](v any) func(oldField Field)
• type ConcreteField
  • func (s *ConcreteField[Model]) IsReadable() bool
  • func (s *ConcreteField[Model]) IsWritable() bool
  • func (s *ConcreteField[Model]) Name() string
  • func (s *ConcreteField[Model]) ToInternalValue(reprModel map[string]any, ctx *gin.Context) (any, error)
  • func (s *ConcreteField[Model]) ToRepresentation(intVal models.InternalValue, ctx *gin.Context) (any, error)
  • func (s *ConcreteField[Model]) WithInternalValueFunc(f InternalValueFunc) Field
  • func (s *ConcreteField[Model]) WithReadOnly() Field
  • func (s *ConcreteField[Model]) WithReadWrite() Field
  • func (s *ConcreteField[Model]) WithRepresentationFunc(f RepresentationFunc) Field
  • func (s *ConcreteField[Model]) WithWriteOnly() Field
• type ErrorFieldIsNotPresentInPayload
  • func NewErrorFieldIsNotPresentInPayload(name string) ErrorFieldIsNotPresentInPayload
  • func (e ErrorFieldIsNotPresentInPayload) Error() string
• type Field
  • func NewField[Model any](name string) Field
• type GRFParsable
• type GRFRepresentable
• type InternalValueFunc
• type RepresentationFunc

Functions

func StaticValue

func StaticValue[Model any](v any) func(oldField Field)

Types

type ConcreteField

type ConcreteField[Model any] struct {
	Readable bool
	Writable bool
	// contains filtered or unexported fields
}

func (*ConcreteField[Model]) IsReadable

func (s *ConcreteField[Model]) IsReadable() bool

func (*ConcreteField[Model]) IsWritable

func (s *ConcreteField[Model]) IsWritable() bool

func (*ConcreteField[Model]) Name

func (s *ConcreteField[Model]) Name() string

func (*ConcreteField[Model]) ToInternalValue

func (s *ConcreteField[Model]) ToInternalValue(reprModel map[string]any, ctx *gin.Context) (any, error)

func (*ConcreteField[Model]) ToRepresentation

func (s *ConcreteField[Model]) ToRepresentation(intVal models.InternalValue, ctx *gin.Context) (any, error)

func (*ConcreteField[Model]) WithInternalValueFunc

func (s *ConcreteField[Model]) WithInternalValueFunc(f InternalValueFunc) Field

func (*ConcreteField[Model]) WithReadOnly

func (s *ConcreteField[Model]) WithReadOnly() Field

func (*ConcreteField[Model]) WithReadWrite

func (s *ConcreteField[Model]) WithReadWrite() Field

func (*ConcreteField[Model]) WithRepresentationFunc

func (s *ConcreteField[Model]) WithRepresentationFunc(f RepresentationFunc) Field

func (*ConcreteField[Model]) WithWriteOnly

func (s *ConcreteField[Model]) WithWriteOnly() Field

type ErrorFieldIsNotPresentInPayload

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

func NewErrorFieldIsNotPresentInPayload

func NewErrorFieldIsNotPresentInPayload(name string) ErrorFieldIsNotPresentInPayload

func (ErrorFieldIsNotPresentInPayload) Error

func (e ErrorFieldIsNotPresentInPayload) Error() string

type Field

type Field interface {
	Name() string
	ToRepresentation(models.InternalValue, *gin.Context) (any, error)
	ToInternalValue(map[string]any, *gin.Context) (any, error)

	IsReadable() bool
	IsWritable() bool

	WithReadOnly() Field
	WithWriteOnly() Field
	WithReadWrite() Field

	WithRepresentationFunc(RepresentationFunc) Field
	WithInternalValueFunc(InternalValueFunc) Field
}

func NewField

func NewField[Model any](name string) Field

type GRFParsable

type GRFParsable interface {
	FromRepresentation(any) error
}

type GRFRepresentable

type GRFRepresentable interface {
	ToRepresentation() (any, error)
}

type InternalValueFunc

type InternalValueFunc func(map[string]any, string, *gin.Context) (any, error)

type RepresentationFunc

type RepresentationFunc func(models.InternalValue, string, *gin.Context) (any, error)