format

Documentation

Index

• Variables
• func Convert[V1 any, V2 any](v V1, v1 Format[V1], v2 Format[V2]) (V2, error)
• type AesGcmFormat
  • func (helper AesGcmFormat) Default() []byte
  • func (helper AesGcmFormat) Marshal(value []byte) ([]byte, error)
  • func (helper AesGcmFormat) Unmarshal(value []byte) ([]byte, error)
• type Base64Format
  • func (helper Base64Format) Default() string
  • func (helper Base64Format) Marshal(value string) ([]byte, error)
  • func (helper Base64Format) Unmarshal(value []byte) (string, error)
• type BytesFormat
  • func (helper BytesFormat) Default() []byte
  • func (helper BytesFormat) Marshal(value []byte) ([]byte, error)
  • func (helper BytesFormat) Unmarshal(value []byte) ([]byte, error)
• type Format
  • func AesGcm(key string) (Format[[]byte], error)
  • func Base64() Format[string]
  • func Bytes() Format[[]byte]
  • func Gengar() Format[string]
  • func Json[T any]() Format[T]
  • func Masked[T any](mask Format[[]byte], actual Format[T]) Format[T]
  • func Ogerpon() Format[[]byte]
  • func Protobuf[T proto.Message]() Format[T]
  • func Protojson[T proto.Message]() Format[T]
  • func String() Format[string]
  • func Yaml[T any]() Format[T]
• type GengarFormat
  • func (helper GengarFormat) Default() string
  • func (helper GengarFormat) Marshal(value string) ([]byte, error)
  • func (helper GengarFormat) Unmarshal(value []byte) (string, error)
• type JsonFormat
  • func (helper JsonFormat[T]) Default() T
  • func (helper JsonFormat[T]) Marshal(value T) ([]byte, error)
  • func (helper JsonFormat[T]) Unmarshal(value []byte) (T, error)
• type MaskedFormat
  • func (helper MaskedFormat[T]) Default() T
  • func (helper MaskedFormat[T]) Marshal(value T) ([]byte, error)
  • func (helper MaskedFormat[T]) Unmarshal(value []byte) (T, error)
• type OgerponFormat
  • func (helper OgerponFormat) Default() []byte
  • func (helper OgerponFormat) Marshal(value []byte) ([]byte, error)
  • func (helper OgerponFormat) Unmarshal(value []byte) ([]byte, error)
• type ProtobufFormat
  • func (helper ProtobufFormat[T]) Default() T
  • func (helper ProtobufFormat[T]) Marshal(value T) ([]byte, error)
  • func (helper ProtobufFormat[T]) Unmarshal(value []byte) (T, error)
• type ProtojsonFormat
  • func (helper ProtojsonFormat[T]) Default() T
  • func (helper ProtojsonFormat[T]) Marshal(value T) ([]byte, error)
  • func (helper ProtojsonFormat[T]) Unmarshal(value []byte) (T, error)
• type StringFormat
  • func (helper StringFormat) Default() string
  • func (helper StringFormat) Marshal(value string) ([]byte, error)
  • func (helper StringFormat) Unmarshal(value []byte) (string, error)
• type YamlFormat
  • func (helper YamlFormat[T]) Default() T
  • func (helper YamlFormat[T]) Marshal(value T) ([]byte, error)
  • func (helper YamlFormat[T]) Unmarshal(value []byte) (T, error)

Variables

var (
	ErrAesCreate             = errors.New("AES cipher creation error")
	ErrGcmCreate             = errors.New("GCM cipher mode creation error")
	ErrAesGcmEncrypt         = errors.New("AES GCM encrypt error")
	ErrAesGcmDecrypt         = errors.New("AES GCM decrypt error")
	ErrAesGcmDecryptTooShort = errors.New("AES GCM bytes to decrypt too short")
)

var (
	ErrFormatConversionMarshal   = errors.New("format conversion error")
	ErrFormatConversionUnmarshal = errors.New("format conversion error")
)

var (
	ErrGhastly = errors.New("ghastly")
	ErrHaunter = errors.New("haunter")
	ErrGengar  = errors.New("gengar")
	ErrBasic   = errors.New("error")
)

var (
	ErrMaskActualMarshal   = errors.New("masking error while converting type to bytes")
	ErrMaskMarshal         = errors.New("masking error while masking bytes")
	ErrMaskActualUnmarshal = errors.New("masking error while converting bytes to type")
	ErrMaskUnmarshal       = errors.New("masking error while unmasking bytes")
)

var (
	ErrWellspringMask  = errors.New("wellspring")
	ErrHearthflameMask = errors.New("hearthflame")
)

Functions

func Convert

func Convert[V1 any, V2 any](
	v V1,
	v1 Format[V1],
	v2 Format[V2],
) (V2, error)

assuming byte compatibility, i.e. bytes <-> proto, string <-> json

Types

type AesGcmFormat

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

func (AesGcmFormat) Default

func (helper AesGcmFormat) Default() []byte

func (AesGcmFormat) Marshal

func (helper AesGcmFormat) Marshal(value []byte) ([]byte, error)

Encrypt

func (AesGcmFormat) Unmarshal

func (helper AesGcmFormat) Unmarshal(value []byte) ([]byte, error)

Decrypt

type Base64Format

type Base64Format struct {
}

func (Base64Format) Default

func (helper Base64Format) Default() string

func (Base64Format) Marshal

func (helper Base64Format) Marshal(value string) ([]byte, error)

func (Base64Format) Unmarshal

func (helper Base64Format) Unmarshal(value []byte) (string, error)

type BytesFormat

type BytesFormat struct {
}

func (BytesFormat) Default

func (helper BytesFormat) Default() []byte

func (BytesFormat) Marshal

func (helper BytesFormat) Marshal(value []byte) ([]byte, error)

func (BytesFormat) Unmarshal

func (helper BytesFormat) Unmarshal(value []byte) ([]byte, error)

type Format

type Format[T any] interface {
	Default() T
	Marshal(T) ([]byte, error)
	Unmarshal([]byte) (T, error)
}

bytes format

func AesGcm

func AesGcm(key string) (Format[[]byte], error)

func Base64

func Base64() Format[string]

func Bytes

func Bytes() Format[[]byte]

func Gengar

func Gengar() Format[string]

func Json

func Json[T any]() Format[T]

func Masked

func Masked[T any](mask Format[[]byte], actual Format[T]) Format[T]

func Ogerpon

func Ogerpon() Format[[]byte]

func Protobuf

func Protobuf[T proto.Message]() Format[T]

func Protojson

func Protojson[T proto.Message]() Format[T]

func String

func String() Format[string]

func Yaml

func Yaml[T any]() Format[T]

type GengarFormat

type GengarFormat struct {
}

because gengar likes to play pranks. for unit testing broken format results

func (GengarFormat) Default

func (helper GengarFormat) Default() string

func (GengarFormat) Marshal

func (helper GengarFormat) Marshal(value string) ([]byte, error)

func (GengarFormat) Unmarshal

func (helper GengarFormat) Unmarshal(value []byte) (string, error)

type JsonFormat

type JsonFormat[T any] struct{}

func (JsonFormat[T]) Default

func (helper JsonFormat[T]) Default() T

func (JsonFormat[T]) Marshal

func (helper JsonFormat[T]) Marshal(value T) ([]byte, error)

func (JsonFormat[T]) Unmarshal

func (helper JsonFormat[T]) Unmarshal(value []byte) (T, error)

type MaskedFormat

type MaskedFormat[T any] struct {
	// contains filtered or unexported fields
}

func (MaskedFormat[T]) Default

func (helper MaskedFormat[T]) Default() T

func (MaskedFormat[T]) Marshal

func (helper MaskedFormat[T]) Marshal(value T) ([]byte, error)

func (MaskedFormat[T]) Unmarshal

func (helper MaskedFormat[T]) Unmarshal(value []byte) (T, error)

type OgerponFormat

type OgerponFormat struct {
}

ogerpon the teal mask. for unit testing broken format results

func (OgerponFormat) Default

func (helper OgerponFormat) Default() []byte

func (OgerponFormat) Marshal

func (helper OgerponFormat) Marshal(value []byte) ([]byte, error)

func (OgerponFormat) Unmarshal

func (helper OgerponFormat) Unmarshal(value []byte) ([]byte, error)

type ProtobufFormat

type ProtobufFormat[T proto.Message] struct{}

func (ProtobufFormat[T]) Default

func (helper ProtobufFormat[T]) Default() T

func (ProtobufFormat[T]) Marshal

func (helper ProtobufFormat[T]) Marshal(value T) ([]byte, error)

func (ProtobufFormat[T]) Unmarshal

func (helper ProtobufFormat[T]) Unmarshal(value []byte) (T, error)

type ProtojsonFormat

type ProtojsonFormat[T proto.Message] struct{}

func (ProtojsonFormat[T]) Default

func (helper ProtojsonFormat[T]) Default() T

func (ProtojsonFormat[T]) Marshal

func (helper ProtojsonFormat[T]) Marshal(value T) ([]byte, error)

func (ProtojsonFormat[T]) Unmarshal

func (helper ProtojsonFormat[T]) Unmarshal(value []byte) (T, error)

type StringFormat

type StringFormat struct {
}

func (StringFormat) Default

func (helper StringFormat) Default() string

func (StringFormat) Marshal

func (helper StringFormat) Marshal(value string) ([]byte, error)

func (StringFormat) Unmarshal

func (helper StringFormat) Unmarshal(value []byte) (string, error)

type YamlFormat

type YamlFormat[T any] struct{}

func (YamlFormat[T]) Default

func (helper YamlFormat[T]) Default() T

func (YamlFormat[T]) Marshal

func (helper YamlFormat[T]) Marshal(value T) ([]byte, error)

func (YamlFormat[T]) Unmarshal

func (helper YamlFormat[T]) Unmarshal(value []byte) (T, error)