databasereader

Documentation

Index

• Variables
• func New(args Args) (*databaseReader, error)
• func NewHeaderMarshalizer(marshalizer marshal.Marshalizer) (*headerMarshalizer, error)
• type Args
• type DatabaseInfo

Variables

var ErrEmptyDbFilePath = errors.New("empty db file path")

ErrEmptyDbFilePath signals that an empty database file path has been provided

var ErrNilDirectoryReader = errors.New("nil directory reader")

ErrNilDirectoryReader signals that a nil directory reader has been provided

var ErrNilMarshalizer = errors.New("nil marshalizer")

ErrNilMarshalizer signals that a nil marshalizer has been provided

var ErrNilPersisterFactory = errors.New("nil persister factory")

ErrNilPersisterFactory signals that a nil persister factory has been provided

var ErrNoDatabaseFound = errors.New("no database found")

ErrNoDatabaseFound signals that no database has been found in the provided path

var ErrNoHeader = errors.New("no header")

ErrNoHeader signals that no header has been found during database read

Functions

func New

func New(args Args) (*databaseReader, error)

New will return a new instance of databaseReader

func NewHeaderMarshalizer

func NewHeaderMarshalizer(marshalizer marshal.Marshalizer) (*headerMarshalizer, error)

NewHeaderMarshalizer returns a new instance of a headerMarshalizer

Types

type Args

type Args struct {
	DirectoryReader   storage.DirectoryReaderHandler
	GeneralConfig     config.Config
	Marshalizer       marshal.Marshalizer
	PersisterFactory  storage.PersisterFactory
	DbPathWithChainID string
}

Args holds the arguments needed for creating a new database reader

type DatabaseInfo

type DatabaseInfo struct {
	Epoch uint32
	Shard uint32
}

DatabaseInfo holds data about a specific database