bitseq

Documentation

Overview

Package bitseq provides a structure and utilities for representing long bitmask as sequence of run-lenght encoded blocks. It operates direclty on the encoded representation, it does not decode/encode.

Index

• type Handle
  • func NewHandle(app string, ds datastore.DataStore, id string, numElements uint32) (*Handle, error)
  • func (h *Handle) Bits() uint32
  • func (h *Handle) Destroy()
  • func (h *Handle) Exists() bool
  • func (h *Handle) FromByteArray(ba []byte) error
  • func (h *Handle) Index() uint64
  • func (h *Handle) IsSet(ordinal uint32) bool
  • func (h *Handle) Key() []string
  • func (h *Handle) KeyPrefix() []string
  • func (h *Handle) Set(ordinal uint32) error
  • func (h *Handle) SetAny() (uint32, error)
  • func (h *Handle) SetIndex(index uint64)
  • func (h *Handle) SetValue(value []byte) error
  • func (h *Handle) String() string
  • func (h *Handle) ToByteArray() ([]byte, error)
  • func (h *Handle) Unselected() uint32
  • func (h *Handle) Unset(ordinal uint32) error
  • func (h *Handle) Value() []byte

Types

type Handle

type Handle struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Handle contains the sequece representing the bitmask and its identifier

func NewHandle

func NewHandle(app string, ds datastore.DataStore, id string, numElements uint32) (*Handle, error)

NewHandle returns a thread-safe instance of the bitmask handler

func (*Handle) Bits

func (h *Handle) Bits() uint32

Bits returns the length of the bit sequence

func (*Handle) Destroy

func (h *Handle) Destroy()

Destroy removes from the datastore the data belonging to this handle

func (*Handle) Exists

func (h *Handle) Exists() bool

Exists method is true if this object has been stored in the DB.

func (*Handle) FromByteArray

func (h *Handle) FromByteArray(ba []byte) error

FromByteArray reads his handle's data from a byte array

func (*Handle) Index

func (h *Handle) Index() uint64

Index returns the latest DB Index as seen by this object

func (*Handle) IsSet

func (h *Handle) IsSet(ordinal uint32) bool

IsSet atomically checks if the ordinal bit is set. In case ordinal is outside of the bit sequence limits, false is returned.

func (*Handle) Key

func (h *Handle) Key() []string

Key provides the Key to be used in KV Store

func (*Handle) KeyPrefix

func (h *Handle) KeyPrefix() []string

KeyPrefix returns the immediate parent key that can be used for tree walk

func (*Handle) Set

func (h *Handle) Set(ordinal uint32) error

Set atomically sets the corresponding bit in the sequence

func (*Handle) SetAny

func (h *Handle) SetAny() (uint32, error)

SetAny atomically sets the first unset bit in the sequence and returns the corresponding ordinal

func (*Handle) SetIndex

func (h *Handle) SetIndex(index uint64)

SetIndex method allows the datastore to store the latest DB Index into this object

func (*Handle) SetValue

func (h *Handle) SetValue(value []byte) error

SetValue unmarshals the data from the KV store

func (*Handle) String

func (h *Handle) String() string

func (*Handle) ToByteArray

func (h *Handle) ToByteArray() ([]byte, error)

ToByteArray converts this handle's data into a byte array

func (*Handle) Unselected

func (h *Handle) Unselected() uint32

Unselected returns the number of bits which are not selected

func (*Handle) Unset

func (h *Handle) Unset(ordinal uint32) error

Unset atomically unsets the corresponding bit in the sequence

func (*Handle) Value

func (h *Handle) Value() []byte

Value marshals the data to be stored in the KV store