internal

Documentation

Index

• Constants
• Variables
• func DecodeWithoutPrefix(buf []byte, valueOffset uint64, v *Entry)
• func DirSize(path string) (int64, error)
• func Exists(path string) bool
• func FullVersion() string
• func GetDatafiles(path string) ([]string, error)
• func GetKeyValueSizes(buf []byte) (uint64, uint64)
• func ParseIds(fns []string) ([]int, error)
• func ReadBytes(r io.Reader) ([]byte, error)
• func ReadIndex(r io.Reader, t art.Tree) error
• func WriteBytes(b []byte, w io.Writer) (int, error)
• func WriteIndex(t art.Tree, w io.Writer) (err error)
• func WriteItem(item Item, w io.Writer) (int, error)
• type Datafile
  • func NewDatafile(path string, id int, readonly bool) (*Datafile, error)
  • func (df *Datafile) Close() error
  • func (df *Datafile) FileID() int
  • func (df *Datafile) Name() string
  • func (df *Datafile) Read() (e Entry, n int64, err error)
  • func (df *Datafile) ReadAt(index, size int64) (e Entry, err error)
  • func (df *Datafile) Size() int64
  • func (df *Datafile) Sync() error
  • func (df *Datafile) Write(e Entry) (int64, int64, error)
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) Decode(v *Entry) (int64, error)
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(msg Entry) (int64, error)
• type Entry
  • func NewEntry(key, value []byte) Entry
• type Item
  • func ReadItem(r io.Reader) (Item, error)

Constants

const (
	KeySize   = 4
	ValueSize = 8
)

const (
	Int32Size  = 4
	Int64Size  = 8
	FileIDSize = Int32Size
	OffsetSize = Int64Size
	SizeSize   = Int64Size
)

const (
	DefaultDatafileFilename = "%09d.data"
)

Variables

var (
	ErrReadonly  = errors.New("error: read only datafile")
	ErrReadError = errors.New("error: read error")
)

var (
	// Version release version
	Version = "0.0.1"

	// Commit will be overwritten automatically by the build system
	Commit = "HEAD"
)

Functions

func DecodeWithoutPrefix

func DecodeWithoutPrefix(buf []byte, valueOffset uint64, v *Entry)

func DirSize

func DirSize(path string) (int64, error)

func Exists

func Exists(path string) bool

func FullVersion

func FullVersion() string

FullVersion returns the full version and commit hash

func GetDatafiles

func GetDatafiles(path string) ([]string, error)

func GetKeyValueSizes

func GetKeyValueSizes(buf []byte) (uint64, uint64)

func ParseIds

func ParseIds(fns []string) ([]int, error)

func ReadBytes

func ReadBytes(r io.Reader) ([]byte, error)

func ReadIndex

func ReadIndex(r io.Reader, t art.Tree) error

func WriteBytes

func WriteBytes(b []byte, w io.Writer) (int, error)

func WriteIndex

func WriteIndex(t art.Tree, w io.Writer) (err error)

func WriteItem

func WriteItem(item Item, w io.Writer) (int, error)

Types

type Datafile

type Datafile struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewDatafile

func NewDatafile(path string, id int, readonly bool) (*Datafile, error)

func (*Datafile) Close

func (df *Datafile) Close() error

func (*Datafile) FileID

func (df *Datafile) FileID() int

func (*Datafile) Name

func (df *Datafile) Name() string

func (*Datafile) Read

func (df *Datafile) Read() (e Entry, n int64, err error)

func (*Datafile) ReadAt

func (df *Datafile) ReadAt(index, size int64) (e Entry, err error)

func (*Datafile) Size

func (df *Datafile) Size() int64

func (*Datafile) Sync

func (df *Datafile) Sync() error

func (*Datafile) Write

func (df *Datafile) Write(e Entry) (int64, int64, error)

type Decoder

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

Decoder wraps an underlying io.Reader and allows you to stream Entry decodings on it.

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder creates a streaming Entry decoder.

func (*Decoder) Decode

func (d *Decoder) Decode(v *Entry) (int64, error)

type Encoder

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

Encoder wraps an underlying io.Writer and allows you to stream Entry encodings on it.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder creates a streaming Entry encoder.

func (*Encoder) Encode

func (e *Encoder) Encode(msg Entry) (int64, error)

Encode takes any Entry and streams it to the underlying writer. Messages are framed with a key-length and value-length prefix.

type Entry

type Entry struct {
	Checksum uint32
	Key      []byte
	Offset   int64
	Value    []byte
}

Entry represents a key/value in the database

func NewEntry

func NewEntry(key, value []byte) Entry

type Item

type Item struct {
	FileID int   `json:"fileid"`
	Offset int64 `json:"offset"`
	Size   int64 `json:"size"`
}

func ReadItem

func ReadItem(r io.Reader) (Item, error)