Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

sturdyc

package module

Go to main page

Versions in this module

v1

v1.1.5

Apr 4, 2025

v1.1.4

Mar 11, 2025

v1.1.3

Feb 17, 2025

v1.1.2

Jan 24, 2025

v1.1.1

Jan 16, 2025

v1.1.0

Jan 9, 2025

Changes in this version

type MetricsRecorder

+ AsynchronousRefresh func()

+ SynchronousRefresh func()

v1.0.8

Dec 21, 2024

Changes in this version

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

+ var ErrMissingRecord = errors.New("sturdyc: the record has been marked as missing in the cache")

+ var ErrNotFound = errors.New("sturdyc: err not found")

+ var ErrOnlyCachedRecords = errors.New("sturdyc: failed to fetch the records that were not in the cache")

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

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

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

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

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

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

+ type BatchResponse map[string]T

+ type Client struct

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

+ func (c *Client[T]) BatchKeyFn(prefix string) KeyFn

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

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

+ func (c *Client[T]) GetMany(keys []string) map[string]T

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

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

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

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

+ 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]) PermutatedBatchKeyFn(prefix string, permutationStruct interface{}) KeyFn

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

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

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

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

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

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

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

+ 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

+ Since func(t time.Time) time.Duration

+ type Config struct

+ type DistributedMetricsRecorder interface

+ DistributedCacheHit func()

+ DistributedCacheMiss func()

+ DistributedFallback func()

+ DistributedMissingRecord func()

+ DistributedRefresh func()

+ type DistributedStorage interface

+ Get func(ctx context.Context, key string) ([]byte, bool)

+ GetBatch func(ctx context.Context, keys []string) map[string][]byte

+ Set func(ctx context.Context, key string, value []byte)

+ SetBatch func(ctx context.Context, records map[string][]byte)

+ type DistributedStorageWithDeletions interface

+ Delete func(ctx context.Context, key string)

+ DeleteBatch func(ctx context.Context, keys []string)

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

+ type KeyFn func(id string) string

+ type Logger interface

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

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

+ type MetricsRecorder interface

+ CacheBatchRefreshSize func(size int)

+ CacheHit func()

+ CacheMiss func()

+ EntriesEvicted func(int)

+ ForcedEviction func()

+ MissingRecord func()

+ ObserveCacheSize func(callback func() int)

+ Refresh func()

+ ShardIndex func(int)

+ type NoopLogger struct

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

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

+ type Option func(*Config)

+ func WithClock(clock Clock) Option

+ func WithDistributedMetrics(metricsRecorder DistributedMetricsRecorder) Option

+ func WithDistributedStorage(storage DistributedStorage) Option

+ func WithDistributedStorageEarlyRefreshes(storage DistributedStorageWithDeletions, refreshAfter time.Duration) Option

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

+ func WithEvictionInterval(interval time.Duration) Option

+ func WithLog(log Logger) Option

+ func WithMetrics(recorder MetricsRecorder) Option

+ func WithMissingRecordStorage() Option

+ func WithNoContinuousEvictions() Option

+ func WithRefreshCoalescing(bufferSize int, bufferDuration time.Duration) Option

+ func WithRelativeTimeKeyFormat(truncation time.Duration) 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

+ func (c *RealClock) Since(t time.Time) time.Duration

+ 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)

+ func (c *TestClock) Since(t time.Time) time.Duration