basestore

Documentation

Overview

basestore defines a set of operations common to the different store types

Index

• func NewBaseIndex(publicKey []byte) iface.StoreIndex
• func NewNoopIndex(_ []byte) iface.StoreIndex
• func SaveSnapshot(ctx context.Context, b iface.Store) (cid.Cid, error)
• type BaseStore
  • func (b *BaseStore) AccessController() accesscontroller.Interface
  • func (b *BaseStore) AddOperation(ctx context.Context, op operation.Operation, ...) (ipfslog.Entry, error)
  • func (b *BaseStore) Address() address.Address
  • func (b *BaseStore) Cache() datastore.Datastore
  • func (b *BaseStore) Close() error
  • func (b *BaseStore) DBName() string
  • func (b *BaseStore) Drop() error
  • func (b *BaseStore) EventBus() event.Bus
  • func (b *BaseStore) IO() ipfslog.IO
  • func (b *BaseStore) IPFS() coreiface.CoreAPI
  • func (b *BaseStore) Identity() *identityprovider.Identity
  • func (b *BaseStore) Index() iface.StoreIndex
  • func (b *BaseStore) InitBaseStore(ipfs coreiface.CoreAPI, identity *identityprovider.Identity, ...) error
  • func (b *BaseStore) Load(ctx context.Context, amount int) error
  • func (b *BaseStore) LoadFromSnapshot(ctx context.Context) error
  • func (b *BaseStore) LoadMoreFrom(ctx context.Context, amount uint, entries []ipfslog.Entry)
  • func (b *BaseStore) Logger() *zap.Logger
  • func (b *BaseStore) OpLog() ipfslog.Log
  • func (b *BaseStore) ReplicationStatus() replicator.ReplicationInfo
  • func (b *BaseStore) Replicator() replicator.Replicator
  • func (b *BaseStore) SortFn() ipfslog.SortFn
  • func (b *BaseStore) Sync(ctx context.Context, heads []ipfslog.Entry) error
  • func (b *BaseStore) Tracer() trace.Tracer
  • func (b *BaseStore) Type() string
• type CanAppendContext
  • func (c *CanAppendContext) GetLogEntries() []logac.LogEntry

Functions

func NewBaseIndex

func NewBaseIndex(publicKey []byte) iface.StoreIndex

NewBaseIndex Creates a new basic index

func NewNoopIndex

func NewNoopIndex(_ []byte) iface.StoreIndex

NewBaseIndex Creates a new basic index

func SaveSnapshot

func SaveSnapshot(ctx context.Context, b iface.Store) (cid.Cid, error)

Types

type BaseStore

type BaseStore struct {

	// Deprecated: if possible don't use this, use EventBus() directly instead
	events.EventEmitter
	// contains filtered or unexported fields
}

BaseStore The base of other stores

func (*BaseStore) AccessController

func (b *BaseStore) AccessController() accesscontroller.Interface

func (*BaseStore) AddOperation

func (b *BaseStore) AddOperation(ctx context.Context, op operation.Operation, onProgressCallback chan<- ipfslog.Entry) (ipfslog.Entry, error)

func (*BaseStore) Address

func (b *BaseStore) Address() address.Address

func (*BaseStore) Cache

func (b *BaseStore) Cache() datastore.Datastore

func (*BaseStore) Close

func (b *BaseStore) Close() error

func (*BaseStore) DBName

func (b *BaseStore) DBName() string

func (*BaseStore) Drop

func (b *BaseStore) Drop() error

func (*BaseStore) EventBus

func (b *BaseStore) EventBus() event.Bus

func (*BaseStore) IO

func (b *BaseStore) IO() ipfslog.IO

func (*BaseStore) IPFS

func (b *BaseStore) IPFS() coreiface.CoreAPI

func (*BaseStore) Identity

func (b *BaseStore) Identity() *identityprovider.Identity

func (*BaseStore) Index

func (b *BaseStore) Index() iface.StoreIndex

func (*BaseStore) InitBaseStore

func (b *BaseStore) InitBaseStore(ipfs coreiface.CoreAPI, identity *identityprovider.Identity, addr address.Address, options *iface.NewStoreOptions) error

InitBaseStore Initializes the store base

func (*BaseStore) Load

func (b *BaseStore) Load(ctx context.Context, amount int) error

func (*BaseStore) LoadFromSnapshot

func (b *BaseStore) LoadFromSnapshot(ctx context.Context) error

func (*BaseStore) LoadMoreFrom

func (b *BaseStore) LoadMoreFrom(ctx context.Context, amount uint, entries []ipfslog.Entry)

func (*BaseStore) Logger

func (b *BaseStore) Logger() *zap.Logger

func (*BaseStore) OpLog

func (b *BaseStore) OpLog() ipfslog.Log

func (*BaseStore) ReplicationStatus

func (b *BaseStore) ReplicationStatus() replicator.ReplicationInfo

func (*BaseStore) Replicator

func (b *BaseStore) Replicator() replicator.Replicator

func (*BaseStore) SortFn

func (b *BaseStore) SortFn() ipfslog.SortFn

func (*BaseStore) Sync

func (b *BaseStore) Sync(ctx context.Context, heads []ipfslog.Entry) error

func (*BaseStore) Tracer

func (b *BaseStore) Tracer() trace.Tracer

func (*BaseStore) Type

func (b *BaseStore) Type() string

type CanAppendContext

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

func (*CanAppendContext) GetLogEntries

func (c *CanAppendContext) GetLogEntries() []logac.LogEntry