summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/xordataexchange/crypt/backend/backend.go
blob: bfe894dced11acc397a97f3ed2f9f0261cacee43 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// Package backend provides the K/V store interface for crypt backends.
package backend

// Response represents a response from a backend store.
type Response struct {
	Value []byte
	Error error
}

// KVPair holds both a key and value when reading a list.
type KVPair struct {
	Key   string
	Value []byte
}

type KVPairs []*KVPair

// A Store is a K/V store backend that retrieves and sets, and monitors
// data in a K/V store.
type Store interface {
	// Get retrieves a value from a K/V store for the provided key.
	Get(key string) ([]byte, error)

	// List retrieves all keys and values under a provided key.
	List(key string) (KVPairs, error)

	// Set sets the provided key to value.
	Set(key string, value []byte) error

	// Watch monitors a K/V store for changes to key.
	Watch(key string, stop chan bool) <-chan *Response
}