cache

package

v1.6.0 Latest Latest Go to latest Published: Nov 9, 2026 License: BSD-2-Clause Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dictyBase/modware-stock

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cache provides a key-value cache contract with in-memory TTL and Redis backends for gRPC middleware caching.

Index ¶

func NewRedisStore(addr string) IOE.IOEither[error, Store]
type MemoryStore
type RedisStore
type Store
- func NewMemoryStore() Store

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewRedisStore ¶

func NewRedisStore(addr string) IOE.IOEither[error, Store]

NewRedisStore connects to Redis at addr, verifies reachability with Ping, and returns the initialized Store.

Types ¶

type MemoryStore ¶

type MemoryStore struct {
	// contains filtered or unexported fields
}

MemoryStore is an in-memory TTL cache backed by ttlcache/v3.

func (*MemoryStore) Close ¶

func (m *MemoryStore) Close() error

Close clears all entries from the in-memory cache.

func (*MemoryStore) Delete ¶

func (m *MemoryStore) Delete(
	_ context.Context,
	key string,
) IOE.IOEither[error, struct{}]

Delete removes key from the in-memory cache.

func (*MemoryStore) Get ¶

func (m *MemoryStore) Get(
	_ context.Context,
	key string,
) IOE.IOEither[error, O.Option[[]byte]]

Get retrieves the cached byte slice for key, returning O.None when the key is missing or expired.

func (*MemoryStore) Set ¶

func (m *MemoryStore) Set(
	_ context.Context,
	key string,
	val []byte,
	ttl time.Duration,
) IOE.IOEither[error, struct{}]

Set stores a defensive copy of val under key with the given TTL.

type RedisStore ¶

type RedisStore struct {
	// contains filtered or unexported fields
}

RedisStore is a Redis-backed Store implementation using go-redis/v9.

func (*RedisStore) Close ¶

func (r *RedisStore) Close() error

Close closes the underlying Redis client connection.

func (*RedisStore) Delete ¶

func (r *RedisStore) Delete(
	ctx context.Context,
	key string,
) IOE.IOEither[error, struct{}]

Delete removes key from Redis.

func (*RedisStore) Get ¶

func (r *RedisStore) Get(
	ctx context.Context,
	key string,
) IOE.IOEither[error, O.Option[[]byte]]

Get retrieves the byte slice stored at key in Redis, mapping redis.Nil to O.None and propagating transport errors on Left.

func (*RedisStore) Set ¶

func (r *RedisStore) Set(
	ctx context.Context,
	key string,
	val []byte,
	ttl time.Duration,
) IOE.IOEither[error, struct{}]

Set writes val at key in Redis with the given TTL.

type Store ¶

type Store interface {
	Get(ctx context.Context, key string) IOE.IOEither[error, O.Option[[]byte]]
	Set(ctx context.Context, key string, val []byte, ttl time.Duration) IOE.IOEither[error, struct{}]
	Delete(ctx context.Context, key string) IOE.IOEither[error, struct{}]
	Close() error
}

Store defines the functional key-value cache contract for serialized protobuf payloads.

func NewMemoryStore ¶

func NewMemoryStore() Store

NewMemoryStore creates an in-memory TTL cache store with touch-on-hit disabled so entries expire strictly after their configured TTL.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL