systemicdb

package

v0.0.2 Latest Latest Go to latest Published: Dec 13, 2022 License: MIT Imports: 3 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

This section is empty.

View Source

var ExpiredCollectionCycles int64

This section is empty.

type NodeData struct {
	Key    string
	Value  []byte
	Expiry int64
}

type SystemicDB struct {
	Meta sdbMeta
	// contains filtered or unexported fields
}

func NewSystemicDB() *SystemicDB

NewSystemicDB simply creates a new instance of the SystemicDB AVL Tree, starts the expired garbage collector and returns a pointer

func (t *SystemicDB) Exists(keyStr string) bool

Exists searches for an element in the AVL Tree and return a bool (true is exists)

func (t *SystemicDB) Get(keyStr string) *NodeData

Get searches for an element in the AVL Tree and returns a NodeData struct which is important parts of the node that a user could need

func (t *SystemicDB) GetCollectionCycleCount() *int64

GetCollectionCycleCount returns a int64 of a count of how many times the expiredGC has run, this is used for testing

func (t *SystemicDB) Insert(keyStr string, value []byte, expiry time.Duration) *node

Insert inserts an element into the AVL Tree and returns the newly created node (includes a rebalance of the tree)

func (t *SystemicDB) IsBalanced() bool

IsBalanced returns true if the AVL Tree is balanced.

func (t *SystemicDB) Max() uint64

Max returns the maximum element in the AVL Tree.

func (t *SystemicDB) Min() uint64

Min returns the minimum element in the AVL Tree.

func (t *SystemicDB) Remove(keyStr string)

Remove removes an element from the AVL Tree (includes a rebalance of the tree)