README
¶
ptree
Ptree is an in-memory immutable radix / patricia tree package for Golang.
Features
- Immutable radix tree
- Copy-on-write radix tree
- Rich transaction support
Installation
go get github.com/surrealdb/ptree
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Copy ¶
type Copy struct {
// contains filtered or unexported fields
}
Copy is a copy of a tree which can be used to apply changes to the radix tree. All changes are applied atomically and a new tree is returned when committed. A Copy is not thread safe.
type Cursor ¶
type Cursor struct {
// contains filtered or unexported fields
}
Cursor represents an iterator that can traverse over all key-value pairs in a tree in sorted order. Cursors can be obtained from a transaction and are valid as long as the transaction is open. Changing data while traversing with a cursor may cause it to be invalidated and return unexpected keys and/or values. You must reposition your cursor after mutating data.
func (*Cursor) Del ¶
Del removes the current item under the cursor from the tree. If the cursor has not yet been positioned using First, Last, or Seek, then no item is deleted and a nil key and value are returned.
func (*Cursor) First ¶
First moves the cursor to the first item in the tree and returns its key and value. If the tree is empty then a nil key and value are returned.
func (*Cursor) Last ¶
Last moves the cursor to the last item in the tree and returns its key and value. If the tree is empty then a nil key and value are returned.
func (*Cursor) Next ¶
Next moves the cursor to the next item in the tree and returns its key and value. If the tree is empty then a nil key and value are returned, and if the cursor is at the end of the tree then a nil key and value are returned. If the cursor has not yet been positioned using First, Last, or Seek, then a nil key and value are returned.
func (*Cursor) Prev ¶
Prev moves the cursor to the previous item in the tree and returns its key and value. If the tree is empty then a nil key and value are returned, and if the cursor is at the start of the tree then a nil key and value are returned. If the cursor has not yet been positioned using First, Last, or Seek, then a nil key and value are returned.
type Node ¶
type Node struct {
// contains filtered or unexported fields
}
Node represents an immutable node in the radix tree which can be either an edge node or a leaf node.
func (*Node) Max ¶
Max returns the key and value of the maximum item in the subtree of the current node.
func (*Node) Min ¶
Min returns the key and value of the minimum item in the subtree of the current node.
func (*Node) Path ¶
Path is used to recurse over the tree only visiting nodes which are above this node in the tree.
type Tree ¶
type Tree struct {
// contains filtered or unexported fields
}
Tree represents an immutable radix tree.
Source Files