kv

Documentation

Index

• func NewNatsKvRepoFx[T any](bucketName string) fx.Option
• type BinaryDataRepo
  • func NewNatsKVBinaryRepo(ctx context.Context, bucketName string, jc *nats.JetstreamClient) (BinaryDataRepo, error)
• type BinaryValue
• type Client
• type Entry
• type Repo
  • func NewNatsKVRepo[T any](ctx context.Context, bucketName string, jc *nats.JetstreamClient) (Repo[T], error)
• type Value

Functions

func NewNatsKvRepoFx

func NewNatsKvRepoFx[T any](bucketName string) fx.Option

Types

type BinaryDataRepo

type BinaryDataRepo interface {
	Set(c context.Context, key string, value []byte) error
	SetWithExpiry(c context.Context, key string, value []byte, duration time.Duration) error
	Get(c context.Context, key string) ([]byte, error)
	ErrKeyNotFound(err error) bool
	Drop(c context.Context, key string) error
}

func NewNatsKVBinaryRepo

func NewNatsKVBinaryRepo(ctx context.Context, bucketName string, jc *nats.JetstreamClient) (BinaryDataRepo, error)

type BinaryValue

type BinaryValue struct {
	Data      []byte
	ExpiresAt time.Time
}

type Client

type Client interface {
	Connect(ctx context.Context) error
	Disconnect(ctx context.Context) error
	Set(c context.Context, key string, value []byte) error
	SetWithExpiry(c context.Context, key string, value []byte, duration time.Duration) error
	Drop(c context.Context, key string) error
	Get(c context.Context, key string) ([]byte, error)
}

type Entry

type Entry[T any] struct {
	Key   string
	Value T
}

type Repo

type Repo[T any] interface {
	Set(c context.Context, key string, value T) error
	SetWithExpiry(c context.Context, key string, value T, duration time.Duration) error
	Get(c context.Context, key string) (T, error)
	Keys(c context.Context, pattern string) ([]string, error)
	List(c context.Context, pattern string) ([]T, error)
	Entries(c context.Context, pattern string) ([]Entry[T], error)
	ErrKeyNotFound(err error) bool
	Drop(c context.Context, key string) error
}

func NewNatsKVRepo

func NewNatsKVRepo[T any](ctx context.Context, bucketName string, jc *nats.JetstreamClient) (Repo[T], error)

type Value

type Value[T any] struct {
	Data      T
	ExpiresAt time.Time
}