sturdyc

May 26, 2024

Changes in this version

type Client

+ func (c *Client[T]) GetManyKeyFn(ids []string, keyFn KeyFn) map[string]T

+ func (c *Client[T]) ScanKeys() []string

+ func (c *Client[T]) SetManyKeyFn(records map[string]T, cacheKeyFn KeyFn) bool

+ func (c *Client[T]) StoreMissingRecord(key string) bool

+ type Logger interface

+ Error func(msg string, args ...any)

+ Warn func(msg string, args ...any)

+ type NoopLogger struct

+ func (l *NoopLogger) Error(_ string, _ ...any)

+ func (l *NoopLogger) Warn(_ string, _ ...any)

type Option

+ func WithLog(log Logger) Option

May 25, 2024

Changes in this version

type Client

+ func (c *Client[T]) NumKeysInflight() int

May 23, 2024

Changes in this version

type Client

+ func (c *Client[T]) GetMany(ids []string, keyFn KeyFn) map[string]T

type Option

+ func WithBackgroundRefreshes(minRefreshTime, maxRefreshTime, retryBaseDelay time.Duration) Option

+ func WithMissingRecordStorage() Option

May 7, 2024

Changes in this version

+ var ErrDeleteRecord = errors.New("record has been deleted at source")

May 7, 2024

Changes in this version

+ var ErrInvalidType = errors.New("invalid response type")

type Client

+ func (c *Client[T]) Get(key string) (T, bool)

+ func (c *Client[T]) GetFetch(ctx context.Context, key string, fetchFn FetchFn[T]) (T, error)

+ func (c *Client[T]) GetFetchBatch(ctx context.Context, ids []string, keyFn KeyFn, fetchFn BatchFetchFn[T]) (map[string]T, error)

+ func (c *Client[T]) Passthrough(ctx context.Context, key string, fetchFn FetchFn[T]) (T, error)

+ func (c *Client[T]) PassthroughBatch(ctx context.Context, ids []string, keyFn KeyFn, fetchFn BatchFetchFn[T]) (map[string]T, error)

+ func (c *Client[T]) Set(key string, value T) bool

+ func (c *Client[T]) SetMany(records map[string]T, cacheKeyFn KeyFn) bool

+ func (c *Client[T]) SetMissing(key string, value T, isMissingRecord bool) bool

+ type Config struct

May 4, 2024

Changes in this version

+ func PassthroughBatch[T any](ctx context.Context, c *Client, ids []string, keyFn KeyFn, ...) (map[string]T, error)

+ func Passthrough[T any](ctx context.Context, c *Client, key string, fetchFn FetchFn[T]) (T, error)

type Client

+ func (c *Client) Delete(key string)

type Option

+ func WithPassthroughBuffering() Option

+ func WithPassthroughPercentage(percentage int) Option

Apr 8, 2024

Changes in this version

+ type BatchResponse map[string]T

Apr 7, 2024

Changes in this version

+ var ErrMissingRecord = errors.New("record is missing")

+ var ErrOnlyCachedRecords = errors.New("failed to fetch the records that we did not have cached")

+ var ErrStoreMissingRecord = errors.New("record not found")

+ func ErrIsStoreMissingRecordOrMissingRecord(err error) bool

+ func FindCutoff(times []time.Time, percentile float64) time.Time

+ func GetFetchBatch[T any](ctx context.Context, client *Client, ids []string, keyFn KeyFn, ...) (map[string]T, error)

+ func GetFetch[T any](ctx context.Context, client *Client, key string, fetchFn FetchFn[T]) (T, error)

+ func Get[T any](c *Client, key string) (T, bool)

+ func Set(c *Client, key string, value any) bool

+ func SetMany[T any](c *Client, records map[string]T, cacheKeyFn KeyFn)

+ type BatchFetchFn func(ctx context.Context, ids []string) (map[string]T, error)

+ type Client struct

+ func New(capacity, numShards int, ttl time.Duration, evictionPercentage int, ...) *Client

+ func (c *Client) BatchKeyFn(prefix string) KeyFn

+ func (c *Client) PermutatedBatchKeyFn(prefix string, permutationStruct interface{}) KeyFn

+ func (c *Client) PermutatedKey(prefix string, permutationStruct interface{}) string

+ func (c *Client) Size() int

+ type Clock interface

+ NewTicker func(d time.Duration) (<-chan time.Time, func())

+ NewTimer func(d time.Duration) (<-chan time.Time, func() bool)

+ Now func() time.Time

+ type FetchFn func(ctx context.Context) (T, error)

+ type KeyFn func(string) string

+ type MetricsRecorder interface

+ CacheBatchRefreshSize func(size int)

+ CacheHit func()

+ CacheMiss func()

+ EntriesEvicted func(int)

+ Eviction func()

+ ForcedEviction func()

+ ObserveCacheSize func(callback func() int)

+ ShardIndex func(int)

+ type Option func(*Client)

+ func WithClock(clock Clock) Option

+ func WithEvictionInterval(interval time.Duration) Option

+ func WithMetrics(recorder MetricsRecorder) Option

+ func WithRefreshBuffering(batchSize int, maxBufferTime time.Duration) Option

+ func WithRelativeTimeKeyFormat(truncation time.Duration) Option

+ func WithStampedeProtection(minRefreshTime, maxRefreshTime, retryBaseDelay time.Duration, storeMisses bool) Option

+ type RealClock struct

+ func NewClock() *RealClock

+ func (c *RealClock) NewTicker(d time.Duration) (<-chan time.Time, func())

+ func (c *RealClock) NewTimer(d time.Duration) (<-chan time.Time, func() bool)

+ func (c *RealClock) Now() time.Time

+ type TestClock struct

+ func NewTestClock(time time.Time) *TestClock

+ func (c *TestClock) Add(d time.Duration)

+ func (c *TestClock) NewTicker(d time.Duration) (<-chan time.Time, func())

+ func (c *TestClock) NewTimer(d time.Duration) (<-chan time.Time, func() bool)

+ func (c *TestClock) Now() time.Time

+ func (c *TestClock) Set(t time.Time)