states

Documentation

Index

• type DB
• type DBID
• type DBMap
  • func (dbm *DBMap) Create(id DBID, path string, spec *beacon.Spec) (db DB, err error)
  • func (dbm *DBMap) Find(id DBID) (db DB, ok bool)
  • func (dbm *DBMap) List() (out []DBID)
  • func (dbm *DBMap) Remove(id DBID) (existed bool)
• type DBStats
• type DBs
• type MemDB
  • func (db *MemDB) Get(root beacon.Root) (state *beacon.BeaconStateView, exists bool, err error)
  • func (db *MemDB) List() (out []beacon.Root)
  • func (db *MemDB) Path() string
  • func (db *MemDB) Remove(root beacon.Root) (exists bool, err error)
  • func (db *MemDB) Spec() *beacon.Spec
  • func (db *MemDB) Stats() DBStats
  • func (db *MemDB) Store(ctx context.Context, state *beacon.BeaconStateView) (exists bool, err error)

Types

type DB

type DB interface {
	// Store a state.
	// Returns exists=true if the state exists (previously), false otherwise. If error, it may not be accurate.
	Store(ctx context.Context, state *beacon.BeaconStateView) (exists bool, err error)
	// Get a state. The state is a view of a shared immutable backing.
	// The view is save to mutate (it forks away from the original backing)
	Get(root beacon.Root) (state *beacon.BeaconStateView, exists bool, err error)
	// Remove removes a state from the DB. Removing a state that does not exist is safe.
	// Returns exists=true if the state exists (previously), false otherwise. If error, it may not be accurate.
	Remove(root beacon.Root) (exists bool, err error)
	// Stats shows some database statistics such as latest write key and entry count.
	Stats() DBStats
	// List all known state roots
	List() []beacon.Root
	// Get Path
	Path() string
	// Spec of states
	Spec() *beacon.Spec
}

type DBID

type DBID string

type DBMap

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

func (*DBMap) Create

func (dbm *DBMap) Create(id DBID, path string, spec *beacon.Spec) (db DB, err error)

func (*DBMap) Find

func (dbm *DBMap) Find(id DBID) (db DB, ok bool)

func (*DBMap) List

func (dbm *DBMap) List() (out []DBID)

func (*DBMap) Remove

func (dbm *DBMap) Remove(id DBID) (existed bool)

type DBStats

type DBStats struct {
	Count     int64
	LastWrite beacon.Root
}

type DBs

type DBs interface {
	Find(id DBID) (db DB, ok bool)
	// Create a new database. An empty path creates a memory DB.
	Create(id DBID, path string, spec *beacon.Spec) (db DB, err error)
	Remove(id DBID) (existed bool)
	List() []DBID
}

type MemDB

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

func (*MemDB) Get

func (db *MemDB) Get(root beacon.Root) (state *beacon.BeaconStateView, exists bool, err error)

func (*MemDB) List

func (db *MemDB) List() (out []beacon.Root)

func (*MemDB) Path

func (db *MemDB) Path() string

func (*MemDB) Remove

func (db *MemDB) Remove(root beacon.Root) (exists bool, err error)

func (*MemDB) Spec

func (db *MemDB) Spec() *beacon.Spec

func (*MemDB) Stats

func (db *MemDB) Stats() DBStats

func (*MemDB) Store

func (db *MemDB) Store(ctx context.Context, state *beacon.BeaconStateView) (exists bool, err error)