Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cache ¶
type Cache[K comparable, V any] struct { // contains filtered or unexported fields }
Cache is used a FIFO (First in first out) cache replacement policy.
In FIFO the item that enter the cache first is evicted first w/o any regard of how often or how many times it was accessed before.
func NewCache ¶
func NewCache[K comparable, V any](opts ...Option) *Cache[K, V]
NewCache creates a new non-thread safe FIFO cache whose capacity is the default size (128).
Example ¶
package main
import (
"fmt"
"github.com/Code-Hex/go-generics-cache/policy/fifo"
)
func main() {
c := fifo.NewCache[string, int]()
c.Set("a", 1)
c.Set("b", 2)
av, aok := c.Get("a")
bv, bok := c.Get("b")
cv, cok := c.Get("c")
fmt.Println(av, aok)
fmt.Println(bv, bok)
fmt.Println(cv, cok)
c.Delete("a")
_, aok2 := c.Get("a")
if !aok2 {
fmt.Println("key 'a' has been deleted")
}
// update
c.Set("b", 3)
newbv, _ := c.Get("b")
fmt.Println(newbv)
}
Output: 1 true 2 true 0 false key 'a' has been deleted 3
func (*Cache[K, V]) Delete ¶
func (c *Cache[K, V]) Delete(key K)
Delete deletes the item with provided key from the cache.
func (*Cache[K, V]) Get ¶
Get gets an item from the cache. Returns the item or zero value, and a bool indicating whether the key was found.
func (*Cache[K, V]) Keys ¶
func (c *Cache[K, V]) Keys() []K
Keys returns cache keys.
Example ¶
package main
import (
"fmt"
"github.com/Code-Hex/go-generics-cache/policy/fifo"
)
func main() {
c := fifo.NewCache[string, int]()
c.Set("foo", 1)
c.Set("bar", 2)
c.Set("baz", 3)
keys := c.Keys()
for _, key := range keys {
fmt.Println(key)
}
}
Output: foo bar baz
Source Files
Click to show internal directories.
Click to hide internal directories.