traversal

Documentation

Overview

Package traversal provides abstraction and implementation needed to traverse all chunks below a given root hash. It tries to parse all manifests and collections in its attempt to log all chunk addresses on the way.

Index

• Variables
• type PutGetter
• type Traverser
  • func New(store PutGetter) Traverser

Variables

var ErrInvalidPyramid = errors.New("traversal: invalid pyramid")

Types

type PutGetter

type PutGetter interface {
	storage.Putter
	storage.Getter
}

type Traverser

type Traverser interface {
	// Traverse iterates through each address related to the supplied one, if possible.
	Traverse(context.Context, boson.Address, boson.AddressIterFunc) error
	// GetPyramid returns pyramid hash and its contains data.
	GetPyramid(context.Context, boson.Address) (map[string][]byte, error)
	// GetChunkHashes returns all stored data chunk related to the given reference, if possible.
	GetChunkHashes(context.Context, boson.Address, map[string][]byte) ([][][]byte, [][]byte, error)
}

Traverser represents service which traverse through address dependent chunks.

func New

func New(store PutGetter) Traverser

New constructs for a new Traverser.