persist

Documentation

Index

• Variables
• func Load(meta Metadata, data interface{}, r io.Reader) error
• func LoadFile(meta Metadata, data interface{}, filename string) error
• func NewSafeFile(filename string) (*safeFile, error)
• func RandomSuffix() string
• func Save(meta Metadata, data interface{}, w io.Writer) error
• func SaveFile(meta Metadata, data interface{}, filename string) error
• type BoltDatabase
  • func OpenDatabase(md Metadata, filename string) (*BoltDatabase, error)
  • func (db *BoltDatabase) Close() error
• type Logger
  • func NewLogger(logFilename string) (*Logger, error)
  • func (l *Logger) Close() error
  • func (l *Logger) Critical(v ...interface{})
• type Metadata

Variables

var (
	// ErrBadVersion indicates that the version number of the file is not
	// compatible with the current codebase.
	ErrBadVersion = errors.New("incompatible version")

	// ErrBadHeader indicates that the file opened is not the file that was
	// expected.
	ErrBadHeader = errors.New("wrong header")
)

Functions

func Load

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

Load loads json data from a reader.

func LoadFile

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

LoadFile loads json data from a file.

func NewSafeFile

func NewSafeFile(filename string) (*safeFile, error)

NewSafeFile returns a file that can atomically be written to disk, minimizing the risk of corruption.

func RandomSuffix

func RandomSuffix() string

RandomSuffix returns a 20 character base32 suffix for a filename. There are 100 bits of entropy, and a very low probability of colliding with existing files unintentionally.

func Save

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

Save saves json data to a writer.

func SaveFile

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

SaveFile atomically saves json data to a file.

Types

type BoltDatabase

type BoltDatabase struct {
	Metadata
	*bolt.DB
}

BoltDatabase is a persist-level wrapper for the bolt database, providing extra information such as a version number.

func OpenDatabase

func OpenDatabase(md Metadata, filename string) (*BoltDatabase, error)

OpenDatabase opens a database filename and checks metadata

func (*BoltDatabase) Close

func (db *BoltDatabase) Close() error

CloseDatabase saves the bolt database to a file, and updates metadata

type Logger

type Logger struct {
	*log.Logger
	// contains filtered or unexported fields
}

Logger is a wrapper for the standard library logger that enforces logging into a file with the Sia-standard settings.

func NewLogger

func NewLogger(logFilename string) (*Logger, error)

NewLogger returns a logger that can be closed. Calls should not be made to the logger after 'Close' has been called.

func (*Logger) Close

func (l *Logger) Close() error

Close terminates the Logger.

func (*Logger) Critical

func (l *Logger) Critical(v ...interface{})

Critical will panic if debug mode is activated, and will log the statement otherwise.

type Metadata

type Metadata struct {
	Header, Version string
}

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