kv

Documentation

Index

• Variables
• type ColferError
  • func (i ColferError) Error() string
• type ColferMax
  • func (m ColferMax) Error() string
• type ColferTail
  • func (i ColferTail) Error() string
• type KV
  • func (o *KV) MarshalBinary() (data []byte, err error)
  • func (o *KV) MarshalLen() (int, error)
  • func (o *KV) MarshalTo(buf []byte) int
  • func (o *KV) Unmarshal(data []byte) (int, error)
  • func (o *KV) UnmarshalBinary(data []byte) error

Variables

var (
	// ColferSizeMax is the upper limit for serial byte sizes.
	ColferSizeMax = 16 * 1024 * 1024
)

Colfer configuration attributes

Types

type ColferError

type ColferError int

ColferError signals a data mismatch as as a byte index.

func (ColferError) Error

func (i ColferError) Error() string

Error honors the error interface.

type ColferMax

type ColferMax string

ColferMax signals an upper limit breach.

func (ColferMax) Error

func (m ColferMax) Error() string

Error honors the error interface.

type ColferTail

type ColferTail int

ColferTail signals data continuation as a byte index.

func (ColferTail) Error

func (i ColferTail) Error() string

Error honors the error interface.

type KV

type KV struct {
	Key string

	Val string
}

func (*KV) MarshalBinary

func (o *KV) MarshalBinary() (data []byte, err error)

MarshalBinary encodes o as Colfer conform encoding.BinaryMarshaler. The error return option is kv.ColferMax.

func (*KV) MarshalLen

func (o *KV) MarshalLen() (int, error)

MarshalLen returns the Colfer serial byte size. The error return option is kv.ColferMax.

func (*KV) MarshalTo

func (o *KV) MarshalTo(buf []byte) int

MarshalTo encodes o as Colfer into buf and returns the number of bytes written. If the buffer is too small, MarshalTo will panic.

func (*KV) Unmarshal

func (o *KV) Unmarshal(data []byte) (int, error)

Unmarshal decodes data as Colfer and returns the number of bytes read. The error return options are io.EOF, kv.ColferError and kv.ColferMax.

func (*KV) UnmarshalBinary

func (o *KV) UnmarshalBinary(data []byte) error

UnmarshalBinary decodes data as Colfer conform encoding.BinaryUnmarshaler. The error return options are io.EOF, kv.ColferError, kv.ColferTail and kv.ColferMax.