-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
3,576 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| // Package lcw adds a thin layer on top of lru and expirable cache providing more limits and common interface. | ||
| // The primary method to get (and set) data to/from the cache is LoadingCache.Get returning stored data for a given key or | ||
| // call provided func to retrieve and store, similar to Guava loading cache. | ||
| // Limits allow max values for key size, number of keys, value size and total size of values in the cache. | ||
| // CacheStat gives general stats on cache performance. | ||
| // 3 flavors of cache provided - NoP (do-nothing cache), ExpirableCache (TTL based), and LruCache | ||
| package lcw | ||
|
|
||
| import ( | ||
| "fmt" | ||
| ) | ||
|
|
||
| // Sizer allows to perform size-based restrictions, optional. | ||
| // If not defined both maxValueSize and maxCacheSize checks will be ignored | ||
| type Sizer interface { | ||
| Size() int | ||
| } | ||
|
|
||
| // LoadingCache defines guava-like cache with Get method returning cached value ao retrieving it if not in cache | ||
| type LoadingCache[V any] interface { | ||
| Get(key string, fn func() (V, error)) (val V, err error) // load or get from cache | ||
| Peek(key string) (V, bool) // get from cache by key | ||
| Invalidate(fn func(key string) bool) // invalidate items for func(key) == true | ||
| Delete(key string) // delete by key | ||
| Purge() // clear cache | ||
| Stat() CacheStat // cache stats | ||
| Keys() []string // list of all keys | ||
| Close() error // close open connections | ||
| } | ||
|
|
||
| // CacheStat represent stats values | ||
| type CacheStat struct { | ||
| Hits int64 | ||
| Misses int64 | ||
| Keys int | ||
| Size int64 | ||
| Errors int64 | ||
| } | ||
|
|
||
| // String formats cache stats | ||
| func (s CacheStat) String() string { | ||
| ratio := 0.0 | ||
| if s.Hits+s.Misses > 0 { | ||
| ratio = float64(s.Hits) / float64(s.Hits+s.Misses) | ||
| } | ||
| return fmt.Sprintf("{hits:%d, misses:%d, ratio:%.2f, keys:%d, size:%d, errors:%d}", | ||
| s.Hits, s.Misses, ratio, s.Keys, s.Size, s.Errors) | ||
| } | ||
|
|
||
| // Nop is do-nothing implementation of LoadingCache | ||
| type Nop[V any] struct{} | ||
|
|
||
| // NewNopCache makes new do-nothing cache | ||
| func NewNopCache[V any]() *Nop[V] { | ||
| return &Nop[V]{} | ||
| } | ||
|
|
||
| // Get calls fn without any caching | ||
| func (n *Nop[V]) Get(_ string, fn func() (V, error)) (V, error) { return fn() } | ||
|
|
||
| // Peek does nothing and always returns false | ||
| func (n *Nop[V]) Peek(string) (V, bool) { var emptyValue V; return emptyValue, false } | ||
|
|
||
| // Invalidate does nothing for nop cache | ||
| func (n *Nop[V]) Invalidate(func(key string) bool) {} | ||
|
|
||
| // Purge does nothing for nop cache | ||
| func (n *Nop[V]) Purge() {} | ||
|
|
||
| // Delete does nothing for nop cache | ||
| func (n *Nop[V]) Delete(string) {} | ||
|
|
||
| // Keys does nothing for nop cache | ||
| func (n *Nop[V]) Keys() []string { return nil } | ||
|
|
||
| // Stat always 0s for nop cache | ||
| func (n *Nop[V]) Stat() CacheStat { | ||
| return CacheStat{} | ||
| } | ||
|
|
||
| // Close does nothing for nop cache | ||
| func (n *Nop[V]) Close() error { | ||
| return nil | ||
| } |
Oops, something went wrong.