kevlar

README

kevlar

kevlar is a minimal overhead key value store backed by the filesystem.

Documentation

Index

• Constants
• func Migrate(dir string) error
• type KeyValues
  • func New(dir, ext string) (KeyValues, error)
• type MutationType
  • func (mt MutationType) String() string

Constants

const (
	JsonExt = ".json"
	GobExt  = ".gob"
	HtmlExt = ".html"
	XmlExt  = ".xml"
)

const UnknownModTime = -1

Functions

func Migrate

func Migrate(dir string) error

Types

type KeyValues

type KeyValues interface {
	Len() int
	Keys() iter.Seq[string]
	Has(key string) bool

	Get(key string) (io.ReadCloser, error)
	Set(key string, data io.Reader) error
	Cut(key string) error

	Since(ts int64, mts ...MutationType) iter.Seq2[string, MutationType]

	LogModTime(key string) int64
	FileModTime(key string) (int64, error)
}

func New

func New(dir, ext string) (KeyValues, error)

New connects a new local key value storage at the specified directory and will use specified extension for the value files

type MutationType

type MutationType int

const (
	Create MutationType = iota
	Update
	Cut
)

func (MutationType) String

func (mt MutationType) String() string