https://github.com/bsm/tinylru
A fast little LRU cache for Go
https://github.com/bsm/tinylru
Last synced: 5 months ago
JSON representation
A fast little LRU cache for Go
- Host: GitHub
- URL: https://github.com/bsm/tinylru
- Owner: bsm
- License: mit
- Fork: true (tidwall/tinylru)
- Created: 2020-05-01T08:21:45.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-01T08:22:42.000Z (about 6 years ago)
- Last Synced: 2025-04-25T14:03:38.620Z (about 1 year ago)
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `tinylru`
[](https://godoc.org/github.com/tidwall/tinylru)
A fast little LRU cache.
## Getting Started
### Installing
To start using `tinylru`, install Go and run go get:
```
$ go get -u github.com/tidwall/tinylru
```
This will retrieve the library.
### Usage
```go
// Create an LRU cache
var cache tinylru.LRU
// Set the cache size. This is the maximum number of items that the cache can
// hold before evicting old items. The default size is 256.
cache.Resize(1024)
// Set a key. Returns the previous value and ok if a previous value exists.
prev, ok := cache.Set("hello", "world")
// Get a key. Returns the value and ok if the value exists.
value, ok := cache.Get("hello")
// Delete a key. Returns the deleted value and ok if a previous value exists.
prev, ok := tr.Delete("hello")
```
A `Set` function may evict old items when adding a new item while LRU is at
capacity. If you want to know what was evicted then use the `SetEvicted`
function.
```go
// Set a key and return the evicted item, if any.
prev, ok, evictedKey, evictedValue, evicted := cache.SetEvicted("hello", "jello")
```
### Contact
Josh Baker [@tidwall](https://twitter.com/tidwall)
### License
`tinylru` source code is available under the MIT License.