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 Service
  • func NewService(storer storage.Storer) Service

Variables

var (
	// ErrInvalidType is returned when the reference was not expected type.
	ErrInvalidType = errors.New("traversal: invalid type")
)

Types

type Service

type Service interface {
	// TraverseAddresses iterates through each address related to the supplied
	// one, if possible.
	TraverseAddresses(context.Context, swarm.Address, swarm.AddressIterFunc) error

	// TraverseBytesAddresses iterates through each address of a bytes.
	TraverseBytesAddresses(context.Context, swarm.Address, swarm.AddressIterFunc) error
	// TraverseFileAddresses iterates through each address of a file.
	TraverseFileAddresses(context.Context, swarm.Address, swarm.AddressIterFunc) error
	// TraverseManifestAddresses iterates through each address of a manifest,
	// as well as each entry found in it.
	TraverseManifestAddresses(context.Context, swarm.Address, swarm.AddressIterFunc) error
}

Service is the service to find dependent chunks for an address.

func NewService

func NewService(storer storage.Storer) Service