store

type DeleteOption func(d *DeleteOptions)

type DeleteOptions struct{}

type ListOption func(l *ListOptions)

type ListOptions struct {
	// Prefix returns all keys that are prefixed with key
	Prefix string
	// Suffix returns all keys that end with key
	Suffix string
	// Limit limits the number of returned keys
	Limit uint
	// Offset when combined with Limit supports pagination
	Offset uint
}

type Option func(o *Options)

type Options struct {
	// Nodes contains the addresses or other connection information of the backing storage.
	// For example, an etcd implementation would contain the nodes of the cluster.
	// A SQL implementation could contain one or more connection strings.
	Nodes []string
	// Namespace allows multiple isolated stores to be kept in one backend, if supported.
	// For example multiple tables in a SQL store.
	Namespace string
	// Prefix sets a global prefix on all keys
	Prefix string
	// Suffix sets a global suffix on all keys
	Suffix string
	// Context should contain all implementation specific options, using context.WithValue.
	Context context.Context
}

type ReadOption func(r *ReadOptions)

type ReadOptions struct {
	// Prefix returns all records that are prefixed with key
	Prefix bool
	// Suffix returns all records that have the suffix key
	Suffix bool
	// Limit limits the number of returned records
	Limit uint
	// Offset when combined with Limit supports pagination
	Offset uint
}

type Record struct {
	Key    string
	Value  []byte
	Expiry time.Duration
}

type Store interface {
	// Init initialises the store. It must perform any required setup on the backing storage implementation and check that it is ready for use, returning any errors.
	Init(...Option) error
	// Options allows you to view the current options.
	Options() Options
	// String returns the name of the implementation.
	String() string
	// Read takes a single key name and optional ReadOptions. It returns matching []*Record or an error.
	Read(key string, opts ...ReadOption) ([]*Record, error)
	// Write() writes a record to the store, and returns an error if the record was not written.
	Write(r *Record, opts ...WriteOption) error
	// Delete removes the record with the corresponding key from the store.
	Delete(key string, opts ...DeleteOption) error
	// List returns any keys that match, or an empty list with no error if none matched.
	List(opts ...ListOption) ([]string, error)
}

type WriteOption func(w *WriteOptions)

type WriteOptions struct {
	// Expiry is the time the record expires
	Expiry time.Time
	// TTL is the time until the record expires
	TTL time.Duration
}