persist

Documentation

Index

• Variables
• func Load(meta Metadata, data interface{}, r io.Reader) error
• func LoadFile(meta Metadata, data interface{}, filename string) error
• func Save(meta Metadata, data interface{}, w io.Writer) error
• func SaveFile(meta Metadata, data interface{}, filename string) error
• type DB
  • func OpenDB(filename string) (DB, error)
• type Metadata

Variables

var (
	ErrBadVersion = errors.New("incompatible version")
	ErrBadHeader  = errors.New("wrong header")
)

var (
	ErrUnknownBlock = errors.New("unknown block")
)

var NilDB nildb

NilDB is a db whose methods are no-ops. Calls to Block will return the zero value of types.Block. Calls to Height will return 0.

Functions

func Load

func Load(meta Metadata, data interface{}, r io.Reader) error

Load loads data from a reader.

func LoadFile

func LoadFile(meta Metadata, data interface{}, filename string) error

LoadFile loads data from a file.

func Save

func Save(meta Metadata, data interface{}, w io.Writer) error

Save saves data to a writer.

func SaveFile

func SaveFile(meta Metadata, data interface{}, filename string) error

SaveFile saves data to a file.

Types

type DB

type DB interface {
	Block(types.BlockHeight) (types.Block, error)
	AddBlock(types.Block) error
	RemoveBlock() error
	Height() (types.BlockHeight, error)
	Close() error
}

A DB is a block database. Right now it is equivalent to a []Block.

func OpenDB

func OpenDB(filename string) (DB, error)

OpenDB returns a database ready for use. If the database file does not exist, it will be created. Only one view of a given database file should be open at any one time.

type Metadata

type Metadata struct {
	Header, Version string
}

Metadata contains the header and version of the data being stored.