blockstore

Documentation

Index

• func WriteInto(view ipld.View, bs BlockWriter) error
• type BlockReader
  • func NewBlockReader(options ...Option) (BlockReader, error)
• type BlockStore
  • func NewBlockStore(options ...Option) (BlockStore, error)
• type BlockWriter
• type Option
  • func WithBlocks(blks []ipld.Block) Option
  • func WithBlocksIterator(blks iter.Seq2[ipld.Block, error]) Option

Functions

func WriteInto

func WriteInto(view ipld.View, bs BlockWriter) error

Types

type BlockReader

type BlockReader interface {
	Get(link ipld.Link) (ipld.Block, bool, error)
	Iterator() iter.Seq2[ipld.Block, error]
}

func NewBlockReader

func NewBlockReader(options ...Option) (BlockReader, error)

type BlockStore

type BlockStore interface {
	BlockReader
	BlockWriter
}

func NewBlockStore

func NewBlockStore(options ...Option) (BlockStore, error)

type BlockWriter

type BlockWriter interface {
	Put(block ipld.Block) error
}

type Option

type Option func(cfg *bsConfig) error

Option is an option configuring a block reader/writer.

func WithBlocks

func WithBlocks(blks []ipld.Block) Option

WithBlocks configures the blocks the blockstore should contain.

func WithBlocksIterator

func WithBlocksIterator(blks iter.Seq2[ipld.Block, error]) Option

WithBlocksIterator configures the blocks the blockstore should contain.