mapDB

package

v0.0.0-...-70a847a Latest Latest Go to latest Published: Apr 12, 2018 License: MIT Imports: 4 Imported by: 0

Details

View Source

const (
	// ErrKeyDoesNotExist is returned when a key does not exist within the map
	ErrKeyDoesNotExist = errors.Error("key does not exist")
)

This section is empty.

This section is empty.

type ForEachFn func(key, value string) (end bool)

ForEachFn is used for iterating over map db items

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

MapDB is a simple map database

func New(dir, name string) (mp *MapDB, err error)

New will return a new map db

func (m *MapDB) Close() (err error)

Close will close map db

func (m *MapDB) Delete(key string) (err error)

Delete will remove a value for a given key within the DB

func (m *MapDB) ForEach(fn ForEachFn) (ended bool)

ForEach will iterate through all the values within the DB

func (m *MapDB) Get(key string) (value string, err error)

Get will retrieve a value from the DB

func (m *MapDB) Put(key, value string) (err error)

Put will set a value for a given key within the DB

func (m *MapDB) Txn(fn func(*Txn) error) (err error)

Txn will begin a new transaction

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

Txn is a MapDB transaction

func (t *Txn) Delete(key string) (err error)

Delete will delete a value

func (t *Txn) Get(key string) (value string, err error)

Get will get a value

func (t *Txn) Put(key, value string) (err error)

Put will put a value