hamt

README

go-hamt-ipld

A CHAMP HAMT implemented using ipld

Table of Contents

• Usage
• API
• Contribute
• License

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
• func NewSerializationError(err error) error
• type BasicCborIpldStore
  • func CSTFromBstore(bs Blockstore) *BasicCborIpldStore
  • func NewCborStore() *BasicCborIpldStore
  • func (s *BasicCborIpldStore) Get(ctx context.Context, c cid.Cid, out interface{}) error
  • func (s *BasicCborIpldStore) GetBlock(ctx context.Context, cid cid.Cid) (block.Block, error)
  • func (s *BasicCborIpldStore) Put(ctx context.Context, v interface{}) (cid.Cid, error)
• type Blockstore
• type CborIpldStore
• type KV
  • func (t *KV) MarshalCBOR(w io.Writer) error
  • func (t *KV) UnmarshalCBOR(br io.Reader) error
• type Node
  • func LoadNode(ctx context.Context, cs CborIpldStore, c cid.Cid, options ...Option) (*Node, error)
  • func NewNode(cs CborIpldStore, options ...Option) *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) 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 (t *Node) UnmarshalCBOR(br io.Reader) error
• type Option
  • func UseTreeBitWidth(bitWidth int) Option
• type Pointer
  • func (t *Pointer) MarshalCBOR(w io.Writer) error
  • func (t *Pointer) UnmarshalCBOR(br io.Reader) error
• type SerializationError
  • func (se SerializationError) Error() string
  • func (se SerializationError) Is(o error) bool
  • func (se SerializationError) Unwrap() error

Variables

var ErrMaxDepth = fmt.Errorf("attempted to traverse hamt beyond max depth")

var ErrNotFound = fmt.Errorf("not found")

Functions

func NewSerializationError

func NewSerializationError(err error) error

Types

type BasicCborIpldStore

type BasicCborIpldStore struct {
	Blocks blocks
	Atlas  *atlas.Atlas
}

BasicCborIpldStore is a simple CborIpldStore made from wrapping a blockstore.

func CSTFromBstore

func CSTFromBstore(bs Blockstore) *BasicCborIpldStore

func NewCborStore

func NewCborStore() *BasicCborIpldStore

func (*BasicCborIpldStore) Get

func (s *BasicCborIpldStore) Get(ctx context.Context, c cid.Cid, out interface{}) error

func (*BasicCborIpldStore) GetBlock

func (s *BasicCborIpldStore) GetBlock(ctx context.Context, cid cid.Cid) (block.Block, error)

func (*BasicCborIpldStore) Put

func (s *BasicCborIpldStore) Put(ctx context.Context, v interface{}) (cid.Cid, error)

type Blockstore

type Blockstore interface {
	Get(cid.Cid) (block.Block, error)
	Put(block.Block) error
}

type CborIpldStore

type CborIpldStore interface {
	Get(ctx context.Context, c cid.Cid, out interface{}) error
	Put(ctx context.Context, v interface{}) (cid.Cid, error)
}

CborIpldStore is the ipld store interface required by the hamt.

type KV

type KV struct {
	Key   string
	Value *cbg.Deferred
}

func (*KV) MarshalCBOR

func (t *KV) MarshalCBOR(w io.Writer) error

func (*KV) UnmarshalCBOR

func (t *KV) UnmarshalCBOR(br io.Reader) error

type Node

type Node struct {
	Bitfield *big.Int   `refmt:"bf"`
	Pointers []*Pointer `refmt:"p"`
	// contains filtered or unexported fields
}

func LoadNode

func LoadNode(ctx context.Context, cs CborIpldStore, c cid.Cid, options ...Option) (*Node, error)

func NewNode

func NewNode(cs CborIpldStore, options ...Option) *Node

NewNode creates a new IPLD HAMT Node with the given store and given options

func (*Node) Copy

func (n *Node) Copy() *Node

func (*Node) Delete

func (n *Node) Delete(ctx context.Context, k string) error

func (*Node) Find

func (n *Node) Find(ctx context.Context, k string, out interface{}) error

func (*Node) Flush

func (n *Node) Flush(ctx context.Context) error

func (*Node) ForEach

func (n *Node) ForEach(ctx context.Context, f func(k string, val interface{}) error) error

func (*Node) MarshalCBOR

func (t *Node) MarshalCBOR(w io.Writer) error

func (*Node) Set

func (n *Node) Set(ctx context.Context, k string, v interface{}) error

func (*Node) UnmarshalCBOR

func (t *Node) UnmarshalCBOR(br io.Reader) error

type Option

type Option func(*Node)

Option is a function that configures the node

func UseTreeBitWidth

func UseTreeBitWidth(bitWidth int) Option

UseTreeBitWidth allows you to set the width of the HAMT tree in bits (from 1-8) via a customized hash function

type Pointer

type Pointer struct {
	KVs  []*KV   `refmt:"v,omitempty"`
	Link cid.Cid `refmt:"l,omitempty"`
	// contains filtered or unexported fields
}

func (*Pointer) MarshalCBOR

func (t *Pointer) MarshalCBOR(w io.Writer) error

func (*Pointer) UnmarshalCBOR

func (t *Pointer) UnmarshalCBOR(br io.Reader) error

type SerializationError

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

func (SerializationError) Error

func (se SerializationError) Error() string

func (SerializationError) Is

func (se SerializationError) Is(o error) bool

func (SerializationError) Unwrap

func (se SerializationError) Unwrap() error