kv

Documentation

Index

• Constants
• Variables
• func HeaderByteFromVersion(v Version) byte
• func TypeFromHeaderByte(b byte) byte
• type DocumentType
• type HeaderType
• type IndexType
• type Key
  • func NewKeyWith(header KeyHeader, key Key) Key
• type KeyHeader
  • func NewKeyHeaderFrom(b []byte) KeyHeader
  • func (header KeyHeader) Bytes() []byte
  • func (header KeyHeader) DocumentType() DocumentType
  • func (header KeyHeader) IndexType() IndexType
  • func (header KeyHeader) String() string
  • func (header KeyHeader) Type() HeaderType
  • func (header KeyHeader) Version() Version
• type Version
  • func VertionFromHeaderByte(b byte) Version

Constants

const (
	DatabaseObject   = HeaderType('D')
	CollectionObject = HeaderType('C')
	DocumentObject   = HeaderType('O')
	IndexObject      = HeaderType('I')
)

const (
	PrimaryIndex   = IndexType(1)
	SecondaryIndex = IndexType(2)
)

const (
	CBOR = DocumentType(1)
)

const (
	V1 = Version(1)
)

Variables

var CollectionKeyHeader = [2]byte{byte(CollectionObject), byte(byte(CBOR) | HeaderByteFromVersion(V1))}

var DatabaseKeyHeader = [2]byte{byte(DatabaseObject), byte(byte(CBOR) | HeaderByteFromVersion(V1))}

var DocumentKeyHeader = [2]byte{byte(DocumentObject), byte(byte(CBOR) | HeaderByteFromVersion(V1))}

var PrimaryIndexHeader = [2]byte{byte(IndexObject), byte(byte(PrimaryIndex) | HeaderByteFromVersion(V1))}

var SecondaryIndexHeader = [2]byte{byte(IndexObject), byte(byte(SecondaryIndex) | HeaderByteFromVersion(V1))}

Functions

func HeaderByteFromVersion

func HeaderByteFromVersion(v Version) byte

func TypeFromHeaderByte

func TypeFromHeaderByte(b byte) byte

Types

type DocumentType

type DocumentType byte

DocumentType represents a document type.

type HeaderType

type HeaderType byte

type IndexType

type IndexType byte

IndexType represents an index type.

type Key

type Key = document.Key

Key represents an object key.

func NewKeyWith

func NewKeyWith(header KeyHeader, key Key) Key

NewKeyWith returns a new key from the specified header and key elements.

type KeyHeader

type KeyHeader [2]byte

KeyHeader represents a header for all keys.

func NewKeyHeaderFrom

func NewKeyHeaderFrom(b []byte) KeyHeader

NewKeyHeader creates a new key header from the specified bytes.

func (KeyHeader) Bytes

func (header KeyHeader) Bytes() []byte

Bytes returns a byte array.

func (KeyHeader) DocumentType

func (header KeyHeader) DocumentType() DocumentType

DocumentType returns a document type.

func (KeyHeader) IndexType

func (header KeyHeader) IndexType() IndexType

IndexType returns an index type.

func (KeyHeader) String

func (header KeyHeader) String() string

String returns a string.

func (KeyHeader) Type

func (header KeyHeader) Type() HeaderType

Type returns a header type.

func (KeyHeader) Version

func (header KeyHeader) Version() Version

Version returns a version.

type Version

type Version byte

Version represents a version.

func VertionFromHeaderByte

func VertionFromHeaderByte(b byte) Version