localdb

Documentation

Index

• Constants
• func DisableLog()
• func EncodeVersion(version Version) ([]byte, error)
• func New(root string) (*localdb, error)
• func UseLogger(logger slog.Logger)
• type Version
  • func DecodeVersion(payload []byte) (*Version, error)

Constants

const (
	UserdbPath              = "users"
	LastPaywallAddressIndex = "lastpaywallindex"

	UserVersion    uint32 = 1
	UserVersionKey        = "userversion"
)

Functions

func DisableLog

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until either UseLogger or SetLogWriter are called.

func EncodeVersion

func EncodeVersion(version Version) ([]byte, error)

EncodeVersion encodes Version into a JSON byte slice.

func New

func New(root string) (*localdb, error)

New creates a new localdb instance.

func UseLogger

func UseLogger(logger slog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using slog.

Types

type Version

type Version struct {
	Version uint32 `json:"version"` // Database version
	Time    int64  `json:"time"`    // Time of record creation
}

Version contains the database version.

func DecodeVersion

func DecodeVersion(payload []byte) (*Version, error)

DecodeVersion decodes a JSON byte slice into a Version.