README.md: Remove one level of indentation and increase 'recommended' cleanupInterval
This commit is contained in:
parent
e7a9def80f
commit
dd1ed0ba63
149
README.md
149
README.md
@ -20,86 +20,85 @@ one) to recover from downtime quickly. (See the docs for `NewFrom()` for caveats
|
|||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/patrickmn/go-cache"
|
"github.com/patrickmn/go-cache"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
// Create a cache with a default expiration time of 5 minutes, and which
|
||||||
|
// purges expired items every 10 minutes
|
||||||
|
c := cache.New(5*time.Minute, 10*time.Minute)
|
||||||
|
|
||||||
// Create a cache with a default expiration time of 5 minutes, and which
|
// Set the value of the key "foo" to "bar", with the default expiration time
|
||||||
// purges expired items every 30 seconds
|
c.Set("foo", "bar", cache.DefaultExpiration)
|
||||||
c := cache.New(5*time.Minute, 30*time.Second)
|
|
||||||
|
|
||||||
// Set the value of the key "foo" to "bar", with the default expiration time
|
// Set the value of the key "baz" to 42, with no expiration time
|
||||||
c.Set("foo", "bar", cache.DefaultExpiration)
|
// (the item won't be removed until it is re-set, or removed using
|
||||||
|
// c.Delete("baz")
|
||||||
// Set the value of the key "baz" to 42, with no expiration time
|
c.Set("baz", 42, cache.NoExpiration)
|
||||||
// (the item won't be removed until it is re-set, or removed using
|
|
||||||
// c.Delete("baz")
|
|
||||||
c.Set("baz", 42, cache.NoExpiration)
|
|
||||||
|
|
||||||
// Get the string associated with the key "foo" from the cache
|
|
||||||
foo, found := c.Get("foo")
|
|
||||||
if found {
|
|
||||||
fmt.Println(foo)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Since Go is statically typed, and cache values can be anything, type
|
|
||||||
// assertion is needed when values are being passed to functions that don't
|
|
||||||
// take arbitrary types, (i.e. interface{}). The simplest way to do this for
|
|
||||||
// values which will only be used once--e.g. for passing to another
|
|
||||||
// function--is:
|
|
||||||
foo, found := c.Get("foo")
|
|
||||||
if found {
|
|
||||||
MyFunction(foo.(string))
|
|
||||||
}
|
|
||||||
|
|
||||||
// This gets tedious if the value is used several times in the same function.
|
|
||||||
// You might do either of the following instead:
|
|
||||||
if x, found := c.Get("foo"); found {
|
|
||||||
foo := x.(string)
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
// or
|
|
||||||
var foo string
|
|
||||||
if x, found := c.Get("foo"); found {
|
|
||||||
foo = x.(string)
|
|
||||||
}
|
|
||||||
// ...
|
|
||||||
// foo can then be passed around freely as a string
|
|
||||||
|
|
||||||
// Want performance? Store pointers!
|
|
||||||
c.Set("foo", &MyStruct, cache.DefaultExpiration)
|
|
||||||
if x, found := c.Get("foo"); found {
|
|
||||||
foo := x.(*MyStruct)
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
|
|
||||||
// If you store a reference type like a pointer, slice, map or channel, you
|
|
||||||
// do not need to run Set if you modify the underlying data. The cached
|
|
||||||
// reference points to the same memory, so if you modify a struct whose
|
|
||||||
// pointer you've stored in the cache, retrieving that pointer with Get will
|
|
||||||
// point you to the same data:
|
|
||||||
foo := &MyStruct{Num: 1}
|
|
||||||
c.Set("foo", foo, cache.DefaultExpiration)
|
|
||||||
// ...
|
|
||||||
x, _ := c.Get("foo")
|
|
||||||
foo := x.(*MyStruct)
|
|
||||||
fmt.Println(foo.Num)
|
|
||||||
// ...
|
|
||||||
foo.Num++
|
|
||||||
// ...
|
|
||||||
x, _ := c.Get("foo")
|
|
||||||
foo := x.(*MyStruct)
|
|
||||||
foo.Println(foo.Num)
|
|
||||||
|
|
||||||
// will print:
|
|
||||||
// 1
|
|
||||||
// 2
|
|
||||||
|
|
||||||
|
// Get the string associated with the key "foo" from the cache
|
||||||
|
foo, found := c.Get("foo")
|
||||||
|
if found {
|
||||||
|
fmt.Println(foo)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Since Go is statically typed, and cache values can be anything, type
|
||||||
|
// assertion is needed when values are being passed to functions that don't
|
||||||
|
// take arbitrary types, (i.e. interface{}). The simplest way to do this for
|
||||||
|
// values which will only be used once--e.g. for passing to another
|
||||||
|
// function--is:
|
||||||
|
foo, found := c.Get("foo")
|
||||||
|
if found {
|
||||||
|
MyFunction(foo.(string))
|
||||||
|
}
|
||||||
|
|
||||||
|
// This gets tedious if the value is used several times in the same function.
|
||||||
|
// You might do either of the following instead:
|
||||||
|
if x, found := c.Get("foo"); found {
|
||||||
|
foo := x.(string)
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
// or
|
||||||
|
var foo string
|
||||||
|
if x, found := c.Get("foo"); found {
|
||||||
|
foo = x.(string)
|
||||||
|
}
|
||||||
|
// ...
|
||||||
|
// foo can then be passed around freely as a string
|
||||||
|
|
||||||
|
// Want performance? Store pointers!
|
||||||
|
c.Set("foo", &MyStruct, cache.DefaultExpiration)
|
||||||
|
if x, found := c.Get("foo"); found {
|
||||||
|
foo := x.(*MyStruct)
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
|
||||||
|
// If you store a reference type like a pointer, slice, map or channel, you
|
||||||
|
// do not need to run Set if you modify the underlying data. The cached
|
||||||
|
// reference points to the same memory, so if you modify a struct whose
|
||||||
|
// pointer you've stored in the cache, retrieving that pointer with Get will
|
||||||
|
// point you to the same data:
|
||||||
|
foo := &MyStruct{Num: 1}
|
||||||
|
c.Set("foo", foo, cache.DefaultExpiration)
|
||||||
|
// ...
|
||||||
|
x, _ := c.Get("foo")
|
||||||
|
foo := x.(*MyStruct)
|
||||||
|
fmt.Println(foo.Num)
|
||||||
|
// ...
|
||||||
|
foo.Num++
|
||||||
|
// ...
|
||||||
|
x, _ := c.Get("foo")
|
||||||
|
foo := x.(*MyStruct)
|
||||||
|
foo.Println(foo.Num)
|
||||||
|
|
||||||
|
// will print:
|
||||||
|
// 1
|
||||||
|
// 2
|
||||||
|
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Reference
|
### Reference
|
||||||
|
Loading…
Reference in New Issue
Block a user