pack

README

pack

Store your stuff.

Documentation

Index

• Constants
• type Error
  • func (pe Error) Error() string
• type KVPack
  • func (k *KVPack) Delete(location, name string) error
  • func (k *KVPack) Get(location, name string) ([]byte, error)
  • func (k *KVPack) List(location string) ([]string, error)
  • func (k *KVPack) ListMeta(location string) ([]interface{}, error)
  • func (k *KVPack) Save(location string, thing Packable) error
• type Pack
  • func New(dbLocation string) Pack
• type Packable

Constants

const ErrThingDoesNotExist = Error("thing does not exist")

Types

type Error

type Error string

func (Error) Error

func (pe Error) Error() string

type KVPack

type KVPack struct {
	sync.Mutex
	// contains filtered or unexported fields
}

KVPack is a simple key/value store to pack stuff in.

func (*KVPack) Delete

func (k *KVPack) Delete(location, name string) error

func (*KVPack) Get

func (k *KVPack) Get(location, name string) ([]byte, error)

func (*KVPack) List

func (k *KVPack) List(location string) ([]string, error)

func (*KVPack) ListMeta

func (k *KVPack) ListMeta(location string) ([]interface{}, error)

func (*KVPack) Save

func (k *KVPack) Save(location string, thing Packable) error

Save will pack the provided thing in the location specified using the name as it's key.

type Pack

type Pack interface {
	Save(location string, thing Packable) error
	Get(location, name string) ([]byte, error)
	Delete(location, name string) error
	List(location string) ([]string, error)
	ListMeta(location string) ([]interface{}, error)
}

Pack is a place to store things.

func New

func New(dbLocation string) Pack

New creates a new KVPack for storing things.

type Packable

type Packable interface {
	Pack() (string, []byte)
	Unpack([]byte)
}

Packable is something that can be stored in a Pack.