helpers

package
v0.4.9-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 1, 2017 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var BlockSizeLimit = 1048576 // 1 MB

BlockSizeLimit specifies the maximum size an imported block can have.

View Source 
var DefaultLinksPerBlock = (roughLinkBlockSize / roughLinkSize)

DefaultLinksPerBlock governs how the importer decides how many links there will be per block. This calculation is based on expected distributions of:

  • the expected distribution of block sizes
  • the expected distribution of link sizes
  • desired access speed

For now, we use: 

var roughLinkBlockSize = 1 << 13 // 8KB
var roughLinkSize = 288          // sha256 + framing + name
var DefaultLinksPerBlock = (roughLinkBlockSize / roughLinkSize)

See calc_test.go

View Source 
var ErrSizeLimitExceeded = fmt.Errorf("object size limit exceeded")

ErrSizeLimitExceeded signals that a block is larger than BlockSizeLimit.

Functions

This section is empty.

Types

type DagBuilderHelper 

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

DagBuilderHelper wraps together a bunch of objects needed to efficiently create unixfs dag trees

func (*DagBuilderHelper) Add 

func (db *DagBuilderHelper) Add(node *UnixfsNode) (node.Node, error)

func (*DagBuilderHelper) Close added in v0.3.6 

func (db *DagBuilderHelper) Close() error

func (*DagBuilderHelper) Done 

func (db *DagBuilderHelper) Done() bool

Done returns whether or not we're done consuming the incoming data.

func (*DagBuilderHelper) FillNodeLayer 

func (db *DagBuilderHelper) FillNodeLayer(node *UnixfsNode) error

FillNodeLayer will add datanodes as children to the give node until at most db.indirSize ndoes are added

func (*DagBuilderHelper) GetDagServ added in v0.3.2 

func (db *DagBuilderHelper) GetDagServ() dag.DAGService

GetDagServ returns the dagservice object this Helper is using

func (*DagBuilderHelper) GetNextDataNode added in v0.4.5 

func (db *DagBuilderHelper) GetNextDataNode() (*UnixfsNode, error)
func (db *DagBuilderHelper) Maxlinks() int

func (*DagBuilderHelper) NewUnixfsBlock added in v0.4.9 

func (db *DagBuilderHelper) NewUnixfsBlock() *UnixfsNode

NewUnixfsBlock creates a new Unixfs node to represent a raw data block

func (*DagBuilderHelper) NewUnixfsNode added in v0.4.9 

func (db *DagBuilderHelper) NewUnixfsNode() *UnixfsNode

NewUnixfsNode creates a new Unixfs node to represent a file.

func (*DagBuilderHelper) Next 

func (db *DagBuilderHelper) Next() ([]byte, error)

Next returns the next chunk of data to be inserted into the dag if it returns nil, that signifies that the stream is at an end, and that the current building operation should finish

func (*DagBuilderHelper) SetPosInfo added in v0.4.5 

func (db *DagBuilderHelper) SetPosInfo(node *UnixfsNode, offset uint64)

type DagBuilderParams 

type DagBuilderParams struct {
	// Maximum number of links per intermediate node
	Maxlinks int

	// RawLeaves signifies that the importer should use raw ipld nodes as leaves
	// instead of using the unixfs TRaw type
	RawLeaves bool

	// CID Prefix to use if set
	Prefix *cid.Prefix

	// DAGService to write blocks to (required)
	Dagserv dag.DAGService

	// NoCopy signals to the chunker that it should track fileinfo for
	// filestore adds
	NoCopy bool
}

func (*DagBuilderParams) New 

func (dbp *DagBuilderParams) New(spl chunk.Splitter) *DagBuilderHelper

Generate a new DagBuilderHelper from the given params, which data source comes from chunks object

type UnixfsNode 

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

UnixfsNode is a struct created to aid in the generation of unixfs DAG trees

func NewUnixfsNodeFromDag added in v0.3.2 

func NewUnixfsNodeFromDag(nd *dag.ProtoNode) (*UnixfsNode, error)

NewUnixfsNodeFromDag reconstructs a Unixfs node from a given dag node

func (*UnixfsNode) AddChild 

func (n *UnixfsNode) AddChild(child *UnixfsNode, db *DagBuilderHelper) error

addChild will add the given UnixfsNode as a child of the receiver. the passed in DagBuilderHelper is used to store the child node an pin it locally so it doesnt get lost

func (*UnixfsNode) FileSize added in v0.4.5 

func (n *UnixfsNode) FileSize() uint64

func (*UnixfsNode) GetChild added in v0.3.2 

func (n *UnixfsNode) GetChild(ctx context.Context, i int, ds dag.DAGService) (*UnixfsNode, error)

func (*UnixfsNode) GetDagNode 

func (n *UnixfsNode) GetDagNode() (node.Node, error)

getDagNode fills out the proper formatting for the unixfs node inside of a DAG node and returns the dag node

func (*UnixfsNode) NumChildren 

func (n *UnixfsNode) NumChildren() int

func (*UnixfsNode) RemoveChild added in v0.3.2 

func (n *UnixfsNode) RemoveChild(index int, dbh *DagBuilderHelper)

Removes the child node at the given index

func (*UnixfsNode) Set added in v0.4.5 

func (n *UnixfsNode) Set(other *UnixfsNode)

func (*UnixfsNode) SetData added in v0.3.2 

func (n *UnixfsNode) SetData(data []byte)

func (*UnixfsNode) SetPosInfo added in v0.4.5 

func (n *UnixfsNode) SetPosInfo(offset uint64, fullPath string, stat os.FileInfo)

func (*UnixfsNode) SetPrefix added in v0.4.9 

func (n *UnixfsNode) SetPrefix(prefix *cid.Prefix)

SetPrefix sets the CID Prefix

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.