carv1

package

v1.8.3 Latest Latest Go to latest Published: May 26, 2023 License: Apache-2.0, MIT, Apache-2.0, + 1 more Imports: 10 Imported by: 0

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

Forked from CARv1 to avoid dependency to ipld-prime 0.9.0 due to outstanding upgrades in filecoin.

View Source

const DefaultMaxAllowedHeaderSize uint64 = 32 << 20 // 32MiB

View Source

const DefaultMaxAllowedSectionSize uint64 = 8 << 20 // 8MiB

This section is empty.

func HeaderSize(h *CarHeader) (uint64, error)

func WriteCar(ctx context.Context, ds format.NodeGetter, roots []cid.Cid, w io.Writer) error

func WriteHeader(h *CarHeader, w io.Writer) error

type CarHeader struct {
	Roots   []cid.Cid
	Version uint64
}

func LoadCar(s Store, r io.Reader) (*CarHeader, error)

func ReadHeader(r io.Reader, maxReadBytes uint64) (*CarHeader, error)

func ReadHeaderAt(at io.ReaderAt, maxReadBytes uint64) (*CarHeader, error)

func (h CarHeader) Matches(other CarHeader) bool

Matches checks whether two headers match. Two headers are considered matching if:

Note, this function explicitly ignores the order of roots. If order of roots matter use reflect.DeepEqual instead.

type CarReader struct {
	Header *CarHeader
	// contains filtered or unexported fields
}

func NewCarReader(r io.Reader) (*CarReader, error)

func NewCarReaderWithZeroLengthSectionAsEOF(r io.Reader) (*CarReader, error)

func NewCarReaderWithoutDefaults(r io.Reader, zeroLenAsEOF bool, maxAllowedHeaderSize uint64, maxAllowedSectionSize uint64) (*CarReader, error)

func (cr *CarReader) Next() (blocks.Block, error)

type ReadStore interface {
	Get(context.Context, cid.Cid) (blocks.Block, error)
}

type Store interface {
	Put(context.Context, blocks.Block) error
}

Path	Synopsis
util