carv1

package

v0.2.0 Latest Latest Go to latest Published: Nov 8, 2023 License: MIT Imports: 16 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

helper package for building car file of version 1

This section is empty.

This section is empty.

func BlockWalk(ctx context.Context, node format.Node, bs format.NodeGetter, batchNum int, cb func(nd format.Node) error) error

func GetNode(ctx context.Context, cid cid.Cid, bs blockstore.Blockstore) (format.Node, error)

func NewOfflineNodeGetter(ng blockstore.Blockstore) *offlineng

func NewOnlineNodeGetter(ng format.DAGService) *onlineng

func PadCar(w io.Writer, carSize int64) error

func PadCarFile(targetPath string) error

func UnpadCarFile(targetPath string) error

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

func NewBatch(ctx context.Context, bs format.NodeGetter) *BatchBuilder

func (b *BatchBuilder) Ref(root cid.Cid, batchNum int) (*Carv1Ref, error)

func (b *BatchBuilder) Write(root cid.Cid, w io.Writer, batchNum int) (uint64, error)

func (b *BatchBuilder) WriteToFile(root cid.Cid, outPath string, batchNum int) error

type Carv1Ref struct {
	Size    uint64
	DataRef []*DataRef
}

func DecodeCarv1Ref(data []byte) (ref *Carv1Ref, err error)

func (cr *Carv1Ref) Encode() ([]byte, error)

type DataRef struct {
	Offset uint64
	Size   uint64
	Type   RefType
	Blocks []string
	Block  string
}

type NullReader struct{}

func (nr NullReader) Read(b []byte) (int, error)

Read writes NUL bytes into the provided byte slice.

type RefType int8

const (
	RefHeader RefType = iota
	RefData
)