blockstore

Apr 23, 2023

Changes in this version

+ type BlockstoreGCOnce interface

+ GCOnce func(ctx context.Context, options ...BlockstoreGCOption) error

type BlockstoreGCOption

+ func WithCheck(check func() error) BlockstoreGCOption

+ func WithCheckFreq(f time.Duration) BlockstoreGCOption

+ func WithThreshold(threshold float64) BlockstoreGCOption

type BlockstoreGCOptions

+ Check func() error

+ CheckFreq time.Duration

+ Threshold float64

type BufferedBlockstore

+ func (bs *BufferedBlockstore) Flush(ctx context.Context) error

+ type Flusher interface

+ Flush func(context.Context) error

type MemBlockstore

+ func (MemBlockstore) Flush(context.Context) error

type NetworkStore

+ func (*NetworkStore) Flush(context.Context) error

type SyncBlockstore

+ func (*SyncBlockstore) Flush(context.Context) error

type TimedCacheBlockstore

+ func (t *TimedCacheBlockstore) Flush(ctx context.Context) error

Dec 13, 2022

Changes in this version

+ type NetRPCErrType byte

+ const NRpcErrGeneric

+ const NRpcErrNotFound

+ type NetRPCReqType byte

+ const NRpcDelete

+ const NRpcGet

+ const NRpcGetSize

+ const NRpcHas

+ const NRpcPut

+ type NetRPCRespType byte

+ const NRpcErr

+ const NRpcMore

+ const NRpcOK

+ type NetRpcErr struct

+ Cid *cid.Cid

+ Msg string

+ Type NetRPCErrType

+ func (t *NetRpcErr) MarshalCBOR(w io.Writer) error

+ func (t *NetRpcErr) UnmarshalCBOR(r io.Reader) (err error)

+ type NetRpcReq struct

+ Cid []cid.Cid

+ Data [][]byte

+ ID uint64

+ Type NetRPCReqType

+ func (t *NetRpcReq) MarshalCBOR(w io.Writer) error

+ func (t *NetRpcReq) UnmarshalCBOR(r io.Reader) (err error)

+ type NetRpcResp struct

+ Data []byte

+ ID uint64

+ Type NetRPCRespType

+ func (t *NetRpcResp) MarshalCBOR(w io.Writer) error

+ func (t *NetRpcResp) UnmarshalCBOR(r io.Reader) (err error)

+ type NetworkStore struct

+ func NewNetworkStore(mss msgio.ReadWriteCloser) *NetworkStore

+ func NewNetworkStoreWS(wc *websocket.Conn) *NetworkStore

+ func (n *NetworkStore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error)

+ func (n *NetworkStore) DeleteBlock(ctx context.Context, c cid.Cid) error

+ func (n *NetworkStore) DeleteMany(ctx context.Context, cids []cid.Cid) error

+ func (n *NetworkStore) Get(ctx context.Context, c cid.Cid) (blocks.Block, error)

+ func (n *NetworkStore) GetSize(ctx context.Context, c cid.Cid) (int, error)

+ func (n *NetworkStore) Has(ctx context.Context, c cid.Cid) (bool, error)

+ func (n *NetworkStore) HashOnRead(enabled bool)

+ func (n *NetworkStore) OnClose(cb func())

+ func (n *NetworkStore) Put(ctx context.Context, block blocks.Block) error

+ func (n *NetworkStore) PutMany(ctx context.Context, blocks []blocks.Block) error

+ func (n *NetworkStore) Stop(ctx context.Context) error

+ func (n *NetworkStore) View(ctx context.Context, c cid.Cid, callback func([]byte) error) error

+ type NetworkStoreHandler struct

+ func HandleNetBstoreStream(ctx context.Context, bs Blockstore, mss msgio.ReadWriteCloser) *NetworkStoreHandler

+ func HandleNetBstoreWS(ctx context.Context, bs Blockstore, wc *websocket.Conn) *NetworkStoreHandler

Jun 24, 2022

Changes in this version

type ChainIO

+ ChainPutObj func(context.Context, blocks.Block) error

Feb 17, 2022

retracted

Changes in this version

+ func IsHotView(ctx context.Context) bool

+ func WithHotView(ctx context.Context) context.Context

+ type AutobatchBlockstore struct

+ func NewAutobatch(ctx context.Context, backingBs Blockstore, bufferCapacity int) *AutobatchBlockstore

+ func (bs *AutobatchBlockstore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error)

+ func (bs *AutobatchBlockstore) DeleteBlock(context.Context, cid.Cid) error

+ func (bs *AutobatchBlockstore) DeleteMany(ctx context.Context, cids []cid.Cid) error

+ func (bs *AutobatchBlockstore) Flush(ctx context.Context) error

+ func (bs *AutobatchBlockstore) Get(ctx context.Context, c cid.Cid) (block.Block, error)

+ func (bs *AutobatchBlockstore) GetSize(ctx context.Context, c cid.Cid) (int, error)

+ func (bs *AutobatchBlockstore) Has(ctx context.Context, c cid.Cid) (bool, error)

+ func (bs *AutobatchBlockstore) HashOnRead(enabled bool)

+ func (bs *AutobatchBlockstore) Put(ctx context.Context, blk block.Block) error

+ func (bs *AutobatchBlockstore) PutMany(ctx context.Context, blks []block.Block) error

+ func (bs *AutobatchBlockstore) Shutdown(ctx context.Context) error

+ func (bs *AutobatchBlockstore) View(ctx context.Context, cid cid.Cid, callback func([]byte) error) error

Aug 16, 2021

Changes in this version

type Blockstore

+ func NewDiscardStore(bs Blockstore) Blockstore

+ type BlockstoreGC interface

+ CollectGarbage func(options ...BlockstoreGCOption) error

+ type BlockstoreGCOption = func(*BlockstoreGCOptions) error

+ func WithFullGC(fullgc bool) BlockstoreGCOption

+ type BlockstoreGCOptions struct

+ FullGC bool

+ type BlockstoreIterator interface

+ ForEachKey func(func(cid.Cid) error) error

+ type BlockstoreSize interface

+ Size func() (int64, error)

Mar 11, 2021

Changes in this version

+ var CacheMeasures = struct{ ... }

+ var CacheMetricsEmitInterval = 5 * time.Second

+ var CacheName = tag.NewKey("cache_name")

+ var CacheViews = struct{ ... }

+ var DefaultViews = []*view.View

+ var ErrNotFound = blockstore.ErrNotFound

+ type BasicBlockstore = blockstore.Blockstore

+ type BatchDeleter interface

+ DeleteMany func(cids []cid.Cid) error

+ type Blockstore interface

+ func Adapt(bs blockstore.Blockstore) Blockstore

+ func CachedBlockstore(ctx context.Context, bs Blockstore, opts CacheOpts) (Blockstore, error)

+ func FromDatastore(dstore ds.Batching) Blockstore

+ func NewAPIBlockstore(cio ChainIO) Blockstore

+ func NewIDStore(bs Blockstore) Blockstore

+ func NewLocalIPFSBlockstore(ctx context.Context, onlineMode bool) (Blockstore, error)

+ func NewRemoteIPFSBlockstore(ctx context.Context, maddr multiaddr.Multiaddr, onlineMode bool) (Blockstore, error)

+ func Union(stores ...Blockstore) Blockstore

+ func UnwrapFallbackStore(bs Blockstore) (Blockstore, bool)

+ func WrapIDStore(bstore blockstore.Blockstore) Blockstore

+ type BufferedBlockstore struct

+ func NewBuffered(base Blockstore) *BufferedBlockstore

+ func NewTieredBstore(r Blockstore, w Blockstore) *BufferedBlockstore

+ func (bs *BufferedBlockstore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error)

+ func (bs *BufferedBlockstore) DeleteBlock(c cid.Cid) error

+ func (bs *BufferedBlockstore) DeleteMany(cids []cid.Cid) error

+ func (bs *BufferedBlockstore) Get(c cid.Cid) (block.Block, error)

+ func (bs *BufferedBlockstore) GetSize(c cid.Cid) (int, error)

+ func (bs *BufferedBlockstore) Has(c cid.Cid) (bool, error)

+ func (bs *BufferedBlockstore) HashOnRead(hor bool)

+ func (bs *BufferedBlockstore) Put(blk block.Block) error

+ func (bs *BufferedBlockstore) PutMany(blks []block.Block) error

+ func (bs *BufferedBlockstore) Read() Blockstore

+ func (bs *BufferedBlockstore) View(c cid.Cid, callback func([]byte) error) error

+ type CacheOpts = blockstore.CacheOpts

+ func DefaultCacheOpts() CacheOpts

+ type ChainIO interface

+ ChainHasObj func(context.Context, cid.Cid) (bool, error)

+ ChainReadObj func(context.Context, cid.Cid) ([]byte, error)

+ type FallbackStore struct

+ func (fbs *FallbackStore) Get(c cid.Cid) (blocks.Block, error)

+ func (fbs *FallbackStore) GetSize(c cid.Cid) (int, error)

+ func (fbs *FallbackStore) SetFallback(missFn func(context.Context, cid.Cid) (blocks.Block, error))

+ type IPFSBlockstore struct

+ func (i *IPFSBlockstore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error)

+ func (i *IPFSBlockstore) DeleteBlock(cid cid.Cid) error

+ func (i *IPFSBlockstore) Get(cid cid.Cid) (blocks.Block, error)

+ func (i *IPFSBlockstore) GetSize(cid cid.Cid) (int, error)

+ func (i *IPFSBlockstore) Has(cid cid.Cid) (bool, error)

+ func (i *IPFSBlockstore) HashOnRead(enabled bool)

+ func (i *IPFSBlockstore) Put(block blocks.Block) error

+ func (i *IPFSBlockstore) PutMany(blocks []blocks.Block) error

+ type MemBlockstore map[cid.Cid]blocks.Block

+ func NewMemory() MemBlockstore

+ func (m MemBlockstore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error)

+ func (m MemBlockstore) DeleteBlock(k cid.Cid) error

+ func (m MemBlockstore) DeleteMany(ks []cid.Cid) error

+ func (m MemBlockstore) Get(k cid.Cid) (blocks.Block, error)

+ func (m MemBlockstore) GetSize(k cid.Cid) (int, error)

+ func (m MemBlockstore) Has(k cid.Cid) (bool, error)

+ func (m MemBlockstore) HashOnRead(enabled bool)

+ func (m MemBlockstore) Put(b blocks.Block) error

+ func (m MemBlockstore) PutMany(bs []blocks.Block) error

+ func (m MemBlockstore) View(k cid.Cid, callback func([]byte) error) error

+ type SyncBlockstore struct

+ func NewMemorySync() *SyncBlockstore

+ func (m *SyncBlockstore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error)

+ func (m *SyncBlockstore) DeleteBlock(k cid.Cid) error

+ func (m *SyncBlockstore) DeleteMany(ks []cid.Cid) error

+ func (m *SyncBlockstore) Get(k cid.Cid) (blocks.Block, error)

+ func (m *SyncBlockstore) GetSize(k cid.Cid) (int, error)

+ func (m *SyncBlockstore) Has(k cid.Cid) (bool, error)

+ func (m *SyncBlockstore) HashOnRead(enabled bool)

+ func (m *SyncBlockstore) Put(b blocks.Block) error

+ func (m *SyncBlockstore) PutMany(bs []blocks.Block) error

+ func (m *SyncBlockstore) View(k cid.Cid, callback func([]byte) error) error

+ type TimedCacheBlockstore struct

+ func NewTimedCacheBlockstore(interval time.Duration) *TimedCacheBlockstore

+ func (t *TimedCacheBlockstore) AllKeysChan(_ context.Context) (<-chan cid.Cid, error)

+ func (t *TimedCacheBlockstore) DeleteBlock(k cid.Cid) error

+ func (t *TimedCacheBlockstore) DeleteMany(ks []cid.Cid) error

+ func (t *TimedCacheBlockstore) Get(k cid.Cid) (blocks.Block, error)

+ func (t *TimedCacheBlockstore) GetSize(k cid.Cid) (int, error)

+ func (t *TimedCacheBlockstore) Has(k cid.Cid) (bool, error)

+ func (t *TimedCacheBlockstore) HashOnRead(_ bool)

+ func (t *TimedCacheBlockstore) Put(b blocks.Block) error

+ func (t *TimedCacheBlockstore) PutMany(bs []blocks.Block) error

+ func (t *TimedCacheBlockstore) Start(_ context.Context) error

+ func (t *TimedCacheBlockstore) Stop(_ context.Context) error

+ func (t *TimedCacheBlockstore) View(k cid.Cid, callback func([]byte) error) error

+ type Viewer = blockstore.Viewer