1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
package cache_test
import (
"context"
"fmt"
"time"
cache "github.com/Code-Hex/go-generics-cache"
"github.com/Code-Hex/go-generics-cache/policy/lfu"
"github.com/Code-Hex/go-generics-cache/policy/lru"
)
func ExampleCache() {
// use simple cache algorithm without options.
c := cache.New[string, int]()
c.Set("a", 1)
gota, aok := c.Get("a")
gotb, bok := c.Get("b")
fmt.Println(gota, aok)
fmt.Println(gotb, bok)
// Output:
// 1 true
// 0 false
}
func ExampleNewContext() {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
// use simple cache algorithm without options.
// an internal janitor will be stopped if specified the context is cancelled.
c := cache.NewContext(ctx, cache.WithJanitorInterval[string, int](3*time.Second))
c.Set("a", 1)
gota, aok := c.Get("a")
gotb, bok := c.Get("b")
fmt.Println(gota, aok)
fmt.Println(gotb, bok)
// Output:
// 1 true
// 0 false
}
func ExampleAsClock() {
// use clock cache algorithm.
c := cache.New(cache.AsClock[string, int]())
c.Set("a", 1)
gota, aok := c.Get("a")
gotb, bok := c.Get("b")
fmt.Println(gota, aok)
fmt.Println(gotb, bok)
// Output:
// 1 true
// 0 false
}
func ExampleWithExpiration() {
c := cache.New(cache.AsFIFO[string, int]())
exp := 250 * time.Millisecond
c.Set("a", 1, cache.WithExpiration(exp))
// check item is set.
gota, aok := c.Get("a")
fmt.Println(gota, aok)
// set again
c.Set("a", 2, cache.WithExpiration(exp))
gota2, aok2 := c.Get("a")
fmt.Println(gota2, aok2)
// waiting expiration.
time.Sleep(exp + 100*time.Millisecond) // + buffer
gota3, aok3 := c.Get("a") // expired
fmt.Println(gota3, aok3)
// Output:
// 1 true
// 2 true
// 0 false
}
func ExampleWithReferenceCount() {
c := cache.New(cache.AsLFU[string, int](lfu.WithCapacity(2)))
// set item with reference count
c.Set("a", 1, cache.WithReferenceCount(5))
// check item is set.
gota, aok := c.Get("a")
fmt.Println(gota, aok)
c.Set("b", 2)
c.Set("c", 3)
// evicted becauce the lowest reference count.
gotb, bok := c.Get("b")
fmt.Println(gotb, bok)
gotc, cok := c.Get("c")
fmt.Println(gotc, cok)
// Output:
// 1 true
// 0 false
// 3 true
}
func ExampleCache_Delete() {
c := cache.New(cache.AsMRU[string, int]())
c.Set("a", 1)
c.Delete("a")
gota, aok := c.Get("a")
fmt.Println(gota, aok)
// Output:
// 0 false
}
func ExampleCache_Keys() {
c := cache.New(cache.AsLFU[string, int]())
c.Set("a", 1)
c.Set("b", 1)
c.Set("c", 1)
fmt.Println(c.Keys())
// Output:
// [a b c]
}
func ExampleCache_Len() {
c := cache.New(cache.AsLFU[string, int]())
c.Set("a", 1)
c.Set("b", 1)
c.Set("c", 1)
fmt.Println(c.Len())
// Output:
// 3
}
func ExampleCache_Contains() {
c := cache.New(cache.AsLRU[string, int]())
c.Set("a", 1)
fmt.Println(c.Contains("a"))
fmt.Println(c.Contains("b"))
// Output:
// true
// false
}
func ExampleCache_GetOrSet() {
c := cache.New(cache.AsLRU[string, int](lru.WithCapacity(10)))
c.Set("a", 1)
val1, ok1 := c.GetOrSet("b", 2)
fmt.Println(val1, ok1)
val2, ok2 := c.GetOrSet("a", 3)
fmt.Println(val2, ok2)
// Output:
// 2 false
// 1 true
}
func ExampleNewNumber() {
nc := cache.NewNumber[string, int]()
nc.Set("a", 1)
nc.Set("b", 2, cache.WithExpiration(time.Minute))
av := nc.Increment("a", 1)
gota, aok := nc.Get("a")
bv := nc.Decrement("b", 1)
gotb, bok := nc.Get("b")
// not set keys
cv := nc.Increment("c", 100)
dv := nc.Decrement("d", 100)
fmt.Println(av, gota, aok)
fmt.Println(bv, gotb, bok)
fmt.Println(cv)
fmt.Println(dv)
// Output:
// 2 2 true
// 1 1 true
// 100
// -100
}
|
