blobindex

Documentation

Index

• func Archive(index ShardedDagIndex, writer io.Writer) error
• func NewDecodeFailureError(reason error) error
• func NewUnknownFormatError(reason error) error
• type MapShardedDagIndex
  • func Extract(r io.Reader) (*MapShardedDagIndex, error)
  • func NewShardedDagIndex(shardSizeHint int) *MapShardedDagIndex
  • func View(root cid.Cid, blocks map[cid.Cid][]byte) (*MapShardedDagIndex, error)
  • func (sdi *MapShardedDagIndex) Archive(w io.Writer) error
  • func (sdi *MapShardedDagIndex) SetSlice(shard mh.Multihash, slice mh.Multihash, byteRange Range)
  • func (sdi *MapShardedDagIndex) Shards() MultihashMap[MultihashMap[Range]]
• type MultihashMap
  • func NewMultihashMap[T any](sizeHint int) MultihashMap[T]
• type Range
• type ShardedDagIndex

Functions

func Archive

func Archive(index ShardedDagIndex, writer io.Writer) error

Archive writes a ShardedDagIndex to a CAR file

func NewDecodeFailureError

func NewDecodeFailureError(reason error) error

NewDecodeFailureError returns an error for a decode failure.

func NewUnknownFormatError

func NewUnknownFormatError(reason error) error

NewUnknownFormatError returns an error for an unknown format.

Types

type MapShardedDagIndex

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

MapShardedDagIndex is an in-memory implementation of ShardedDagIndex using MultihashMap.

func Extract

func Extract(r io.Reader) (*MapShardedDagIndex, error)

Extract extracts a sharded dag index from a car

func NewShardedDagIndex

func NewShardedDagIndex(shardSizeHint int) *MapShardedDagIndex

NewShardedDagIndex constructs an empty sharded DAG index. shardSizeHint is used to preallocate the number of shards that will be added. Set to -1 if unknown.

func View

func View(root cid.Cid, blocks map[cid.Cid][]byte) (*MapShardedDagIndex, error)

func (*MapShardedDagIndex) Archive

func (sdi *MapShardedDagIndex) Archive(w io.Writer) error

func (*MapShardedDagIndex) SetSlice

func (sdi *MapShardedDagIndex) SetSlice(shard mh.Multihash, slice mh.Multihash, byteRange Range)

func (*MapShardedDagIndex) Shards

func (sdi *MapShardedDagIndex) Shards() MultihashMap[MultihashMap[Range]]

type MultihashMap

type MultihashMap[T any] interface {
	bytemap.ByteMap[mh.Multihash, T]
}

MultihashMap is a map for mapping multihash digests to arbitrary data types.

func NewMultihashMap

func NewMultihashMap[T any](sizeHint int) MultihashMap[T]

NewMultihashMap returns a new map of multihash to a data type

type Range

type Range = dm.RangeModel

Range describes a start and end byte offset within a shard (inclusive).

type ShardedDagIndex

type ShardedDagIndex interface {
	// Index information for shards the DAG is split across.
	Shards() MultihashMap[MultihashMap[Range]]
}

ShardedDagIndex is a blob index for a DAG stored over one or more shards.