record

Documentation

Index

• Constants
• func DisableKeyNameTracking()
• func EnableKeyNameTracking()
• func ReadBinary[V any](v *V, read func(uint) (V, bool))
• type Key
  • func KeyFromHash(kh KeyHash) *Key
  • func NewKey(v ...any) *Key
  • func (k *Key) Append(v ...any) *Key
  • func (k *Key) AppendKey(l *Key) *Key
  • func (k *Key) Compare(l *Key) int
  • func (k *Key) Copy() *Key
  • func (k *Key) CopyAsInterface() any
  • func (k *Key) Equal(l *Key) bool
  • func (k *Key) Get(i int) any
  • func (k *Key) Hash() KeyHash
  • func (k *Key) Len() int
  • func (k *Key) MarshalBinary() ([]byte, error)
  • func (k *Key) MarshalJSON() ([]byte, error)
  • func (k *Key) SliceI(i int) *Key
  • func (k *Key) SliceJ(j int) *Key
  • func (k *Key) String() string
  • func (k *Key) Stringf(format string) string
  • func (k *Key) UnmarshalBinary(b []byte) error
  • func (k *Key) UnmarshalBinaryFrom(rd io.Reader) error
  • func (k *Key) UnmarshalJSON(b []byte) error
• type KeyHash
  • func (k KeyHash) Append(key ...interface{}) KeyHash
  • func (k KeyHash) MarshalJSON() ([]byte, error)
  • func (k KeyHash) String() string

Constants

const KeyHashLength = 32

Functions

func DisableKeyNameTracking

func DisableKeyNameTracking()

func EnableKeyNameTracking

func EnableKeyNameTracking()

func ReadBinary

func ReadBinary[V any](v *V, read func(uint) (V, bool))

Types

type Key

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

A Key is the key for a record.

func KeyFromHash

func KeyFromHash(kh KeyHash) *Key

func NewKey

func NewKey(v ...any) *Key

func (*Key) Append

func (k *Key) Append(v ...any) *Key

Append creates a child key of this key.

func (*Key) AppendKey

func (k *Key) AppendKey(l *Key) *Key

AppendKey appends one key to another. AppendKey will panic if K is not empty and L starts with a precomputed KeyHash.

func (*Key) Compare

func (k *Key) Compare(l *Key) int

Compare compares two keys. Compare may panic if either key has an unexpected value type.

func (*Key) Copy

func (k *Key) Copy() *Key

Copy returns a copy of the key.

func (*Key) CopyAsInterface

func (k *Key) CopyAsInterface() any

CopyAsInterface implements encoding.BinaryValue.

func (*Key) Equal

func (k *Key) Equal(l *Key) bool

Equal checks if the two keys are equal.

func (*Key) Get

func (k *Key) Get(i int) any

func (*Key) Hash

func (k *Key) Hash() KeyHash

Hash converts the record key to a storage key.

func (*Key) Len

func (k *Key) Len() int

func (*Key) MarshalBinary

func (k *Key) MarshalBinary() ([]byte, error)

MarshalBinary marshals the key to bytes.

func (*Key) MarshalJSON

func (k *Key) MarshalJSON() ([]byte, error)

MarshalJSON marshals the key to JSON.

The key is marshaled as an list of single item objects where the key is the type code and the value is the value. For example:

[{"string": "Account"}, {"url": "foo.acme"}, {"string": "MainChain"}, {"string": "Element"}, {"int": 1}]

func (*Key) SliceI

func (k *Key) SliceI(i int) *Key

func (*Key) SliceJ

func (k *Key) SliceJ(j int) *Key

func (*Key) String

func (k *Key) String() string

String returns a human-readable string for the key.

func (*Key) Stringf

func (k *Key) Stringf(format string) string

func (*Key) UnmarshalBinary

func (k *Key) UnmarshalBinary(b []byte) error

UnmarshalBinary unmarshals a key from bytes.

func (*Key) UnmarshalBinaryFrom

func (k *Key) UnmarshalBinaryFrom(rd io.Reader) error

UnmarshalBinaryFrom unmarshals a key from bytes.

func (*Key) UnmarshalJSON

func (k *Key) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals a key from JSON.

See Key.MarshalJSON for the format and an example.

type KeyHash

type KeyHash [KeyHashLength]byte

func (KeyHash) Append

func (k KeyHash) Append(key ...interface{}) KeyHash

func (KeyHash) MarshalJSON

func (k KeyHash) MarshalJSON() ([]byte, error)

MarshalJSON is implemented for JSON-based logging

func (KeyHash) String

func (k KeyHash) String() string

String hex encodes the key. If debugging is enabled, String looks up the original composite key.