state

package

v0.1.0 Latest Latest Go to latest Published: Dec 21, 2022 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	InMemory = iota
	BoltDB
)

This section is empty.

This section is empty.

type KeyValueStore[K, V any] interface {
	ReadOnlyKeyValueStore[K, V]

	Put(key K, value V)
	Delete(key K)
}

func NewKeyValueStore[K, V any](opts Options[K, V]) KeyValueStore[K, V]

type Option[K, V any] func(*options[K, V])

func WithBoltDB[K, V any](name string) Option[K, V]

WithBoltDB use boltDB persistent store.

func WithDirPath[K, V any](dirPath string) Option[K, V]

func WithInMemory[K, V any]() Option[K, V]

WithInMemory use in-memory store. default store type.

func WithKeySerde[K, V any](keySerde Serde[K]) Option[K, V]

WithKeySerde set custom key serializer/deserializer. default is json serde.

func WithValueSerde[K, V any](valueSerde Serde[V]) Option[K, V]

WithValueSerde set custom value serializer/deserializer. default is json serde.

type Options[K, V any] interface {
	KeySerde() Serde[K]
	ValueSerde() Serde[V]
	StoreType() StoreType
	Name() string
	DirPath() string
}

func NewOptions[K, V any](opts ...Option[K, V]) Options[K, V]

type ReadOnlyKeyValueStore[K, V any] interface {
	Get(key K) (V, error)
}

type Serde[T any] interface {
	Serialize(T) []byte
	Deserialize([]byte) T
}

type StoreType int