mapper

Documentation

Index

• Constants
• Variables
• type Generator
• type JSONGenerator
  • func NewJSONGenerator(mode *goflagsmode.Flag) *JSONGenerator
  • func (j *JSONGenerator) NewMapper(structInstance interface{}) (*Mapper, error)
• type Mapper
• type ProtobufGenerator
  • func NewProtobufGenerator(mode *goflagsmode.Flag) *ProtobufGenerator
  • func (p *ProtobufGenerator) NewMapper(structInstance interface{}) (*Mapper, error)

Constants

const (
	State              = "state"
	SizeCache          = "sizeCache"
	UnknownFields      = "unknownFields"
	ProtobufTag        = "protobuf"
	ProtobufOneOf      = "oneof"
	ProtobufNamePrefix = "name="
	JSONTag            = "json"
	JSONOmitempty      = "omitempty"
)

Protobuf fields generated by the protoc compiler

Variables

var (
	MissingProtobufTagError                 = "missing protobuf tag: %s"
	MissingProtobufTagNameError             = "missing protobuf tag name: %s"
	DuplicateProtobufTagNameError           = "duplicate protobuf tag name: %s"
	MissingJSONTagError                     = "missing json tag: %s"
	MissingJSONTagLooksLikeProtocFieldError = "missing json tag, looks like a protoc field: %s. If it is a protoc field, use ProtobufGenerator instead"
	EmptyJSONTagError                       = "empty json tag: %s"
	DuplicateJSONTagNameError               = "duplicate json tag name: %s"
)

Types

type Generator

type Generator interface {
	NewMapper(structInstance interface{}) (*Mapper, error)
}

Generator is an interface for creating a mapper

type JSONGenerator

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

JSONGenerator is a generator for JSON mappers

func NewJSONGenerator

func NewJSONGenerator(mode *goflagsmode.Flag) *JSONGenerator

NewJSONGenerator creates a new JSON generator

func (*JSONGenerator) NewMapper

func (j *JSONGenerator) NewMapper(structInstance interface{}) (
	*Mapper,
	error,
)

NewMapper creates the fields to validate from a JSON struct

type Mapper

type Mapper struct {
	Fields        map[string]string // Key is the field name and value is the name used in the validation error
	NestedMappers map[string]*Mapper
}

Mapper is a map of fields to validate from a struct

type ProtobufGenerator

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

ProtobufGenerator is a generator for Protobuf mappers

func NewProtobufGenerator

func NewProtobufGenerator(mode *goflagsmode.Flag) *ProtobufGenerator

NewProtobufGenerator creates a new Protobuf generator

func (*ProtobufGenerator) NewMapper

func (p *ProtobufGenerator) NewMapper(structInstance interface{}) (
	*Mapper,
	error,
)

NewMapper creates the fields to validate from a Protobuf compiled struct