keyformat

Documentation

Index

• type CustomFormat
  • func H(inner interface{}) CustomFormat
• type KeyFormat
  • func New(prefix byte, layout ...interface{}) *KeyFormat
  • func (k *KeyFormat) Decode(data []byte, values ...interface{}) bool
  • func (k *KeyFormat) Encode(values ...interface{}) []byte
  • func (k *KeyFormat) Prefix() byte
  • func (k *KeyFormat) Size() int
• type Namespace
  • func NewNamespace(namespace string) *Namespace
  • func (f *Namespace) New(prefix byte, layout ...interface{}) *KeyFormat
• type PreHashed
  • func (ph *PreHashed) Equal(cmp *PreHashed) bool
  • func (ph *PreHashed) MarshalBinary() ([]byte, error)
  • func (ph PreHashed) String() string
  • func (ph *PreHashed) UnmarshalBinary(data []byte) error

Types

type CustomFormat

type CustomFormat interface {
	// Size returns the size of the encoded element.
	Size() int

	// MarshalBinary encodes the passed value into its binary representation.
	MarshalBinary(v interface{}) ([]byte, error)

	// UnmarshalBinary decodes the passed value from its binary representation.
	UnmarshalBinary(v interface{}, data []byte) error
}

CustomFormat specifies a custom encoding format for a key element.

func H

func H(inner interface{}) CustomFormat

H wraps a key element to signal that the element should be hashed after regular encoding.

type KeyFormat

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

KeyFormat is a key formatting helper to be used together with key-value backends for constructing keys.

func New

func New(prefix byte, layout ...interface{}) *KeyFormat

New constructs a new key format.

func (*KeyFormat) Decode

func (k *KeyFormat) Decode(data []byte, values ...interface{}) bool

Decode decodes a key into its individual values.

Returns false and doesn't modify the passed values if the key prefix doesn't match.

*NOTE:* If decoding fails for one of the values, previous values will be modified.

func (*KeyFormat) Encode

func (k *KeyFormat) Encode(values ...interface{}) []byte

Encode encodes values into a key.

You can pass either the same amount of values as specified in the layout or less. In case less values are specified this will generate a shorter key containing only the specified values.

In case no values are specified this will only output the key prefix.

func (*KeyFormat) Prefix

func (k *KeyFormat) Prefix() byte

Prefix returns the key format's prefix byte.

func (*KeyFormat) Size

func (k *KeyFormat) Size() int

Size returns the minimum size in bytes of the resulting key.

type Namespace

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

Namespace is a tool for constructing unique key formats within a namespace.

func NewNamespace

func NewNamespace(namespace string) *Namespace

NewNamespace constructs a new key format namespace.

func (*Namespace) New

func (f *Namespace) New(prefix byte, layout ...interface{}) *KeyFormat

New constructs a new key format.

The prefix must be unique; otherwise, this method will panic.

type PreHashed

type PreHashed hash.Hash

PreHashed represents a pre-hashed value that will be encoded without additional hashing when used together with a hashed format.

func (*PreHashed) Equal

func (ph *PreHashed) Equal(cmp *PreHashed) bool

Equal compares vs another hash for equality.

func (*PreHashed) MarshalBinary

func (ph *PreHashed) MarshalBinary() ([]byte, error)

MarshalBinary encodes a hash into binary form.

func (PreHashed) String

func (ph PreHashed) String() string

String returns the string representation of a hash.

func (*PreHashed) UnmarshalBinary

func (ph *PreHashed) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes a binary marshaled hash.