dagspliter

Documentation

Index

• type Box
  • func (t *Box) MarshalCBOR(w io.Writer) error
  • func (t *Box) UnmarshalCBOR(r io.Reader) error
• type Builder
  • func NewBuilder(dserv ipld.DAGService, chunksize uint64, minSubgraphSize uint64) *Builder
  • func (b *Builder) Boxes() []*Box
  • func (b *Builder) Pack(ctx context.Context, root cid.Cid) error

Types

type Box

type Box struct {
	/// CID of the roots of the *partial* DAGs contained in this Box.
	Roots []cid.Cid
	/// CIDs of the roots of the sub-DAGs excluded from the original DAGs
	/// (delimited by Roots). We don't keep track of which sub-DAG is being
	/// trimmed from which full DAG in Roots, so to obtain the *partial* DAGs
	/// one needs to walk each DAG in Roots checking if any of its links
	/// are contained here.
	External []cid.Cid
}

/ Box is a way of packing together *partial* DAGs to achieve a certain size / while generating the associated CAR file containing them. It is an / alternative to actual re-chunking the DAG nodes which can be expensive for / very large DAGs. A *partial* DAG is generated by excluding certain sub-DAGs / from it.

func (*Box) MarshalCBOR

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

func (*Box) UnmarshalCBOR

func (t *Box) UnmarshalCBOR(r io.Reader) error

type Builder

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

func NewBuilder

func NewBuilder(dserv ipld.DAGService, chunksize uint64, minSubgraphSize uint64) *Builder

func (*Builder) Boxes

func (b *Builder) Boxes() []*Box

func (*Builder) Pack

func (b *Builder) Pack(ctx context.Context, root cid.Cid) error