kv

package

v1.3.0 Latest Latest Go to latest Published: Dec 30, 2023 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cybergarage/puzzledb-go

Links

Open Source Insights

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
type Version
- func VertionFromHeaderByte(b byte) Version

Constants ¶

View Source

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

View Source

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

View Source

const (
	CBOR = DocumentType(1)
)

View Source

const (
	V1 = Version(1)
)

Variables ¶

View Source

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

View Source

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

View Source

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

View Source

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

View Source

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL