The highest tagged major version is
README
¶
go-hamt-ipld
A CHAMP HAMT implemented using ipld
Table of Contents
Examples
// TODO
Contribute
PRs are welcome!
Small note: If editing the Readme, please conform to the standard-readme specification.
License
MIT © Whyrusleeping
Documentation
¶
Index ¶
- Variables
- type KV
- type Node
- func (n *Node) Copy() *Node
- func (n *Node) Delete(ctx context.Context, k string) error
- func (n *Node) Find(ctx context.Context, k string, out interface{}) error
- func (n *Node) FindRaw(ctx context.Context, k string) ([]byte, error)
- func (n *Node) Flush(ctx context.Context) error
- func (n *Node) ForEach(ctx context.Context, f func(k string, val interface{}) error) error
- func (t *Node) MarshalCBOR(w io.Writer) error
- func (n *Node) Set(ctx context.Context, k string, v interface{}) error
- func (n *Node) SetRaw(ctx context.Context, k string, raw []byte) error
- func (t *Node) UnmarshalCBOR(r io.Reader) error
- type Option
- type Pointer
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrMaxDepth = fmt.Errorf("attempted to traverse hamt beyond max depth")
View Source
var ErrNotFound = fmt.Errorf("not found")
Functions ¶
This section is empty.
Types ¶
type Node ¶
type Node struct {
Bitfield *big.Int `refmt:"bf"`
Pointers []*Pointer `refmt:"p"`
// contains filtered or unexported fields
}
type Option ¶
type Option func(*Node)
Option is a function that configures the node
func UseHashFunction ¶
UseHashFunction allows you to set the hash function used by the HAMT. It defaults to murmur3 but you should use sha256 when an attacker can pick the keys.
func UseTreeBitWidth ¶
UseTreeBitWidth allows you to set the width of the HAMT tree in bits (from 1-8) via a customized hash function
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.