store package

Mon, 01 Jan 0001 00:00:00 +0000

import "github.com/zestor-dev/zestor/store"

The store package defines interfaces, types, and options for Zestor stores.

Interfaces

Reader[T any]

Read-only access to the store.

type Reader[T any] interface {
 Get(kind, key string) (val T, ok bool, err error)
 List(kind string, filter ...FilterFunc[T]) (map[string]T, error)
 Count(kind string) (int, error)
 Keys(kind string) ([]string, error)
 Values(kind string) ([]KeyValue[T], error)
 GetAll() (map[string]map[string]T, error)
}

Writer[T any]

Write access to the store.

type Writer[T any] interface {
 Set(kind, key string, value T) (created bool, err error)
 SetFn(kind, key string, fn func(v T) (T, error)) (changed bool, err error)
 SetAll(kind string, values map[string]T) error
 Delete(kind, key string) (existed bool, prev T, err error)
}

Watcher[T any]

Watch access to the store.

type Watcher[T any] interface {
 Watch(kind string, opts ...WatchOption[T]) (r <-chan *Event[T], cancel func(), err error)
}

ReadWriter[T any]

Combined read and write access.

API Reference on Zestor

store package

Interfaces

Reader[T any]

Writer[T any]

Watcher[T any]

ReadWriter[T any]