https://github.com/0xc000022070/filecache
A simple and modern cache implementation based on memory and then in FS written in Go
https://github.com/0xc000022070/filecache
cache file-based-cache filesystem library
Last synced: 7 months ago
JSON representation
A simple and modern cache implementation based on memory and then in FS written in Go
- Host: GitHub
- URL: https://github.com/0xc000022070/filecache
- Owner: 0xc000022070
- Created: 2024-06-15T22:09:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T22:25:36.000Z (almost 2 years ago)
- Last Synced: 2025-02-25T23:15:08.877Z (over 1 year ago)
- Topics: cache, file-based-cache, filesystem, library
- Language: Go
- Homepage: https://pkg.go.dev/github.com/0xc000022070/filecache
- Size: 16.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.md
Awesome Lists containing this project
README
# File cache
A simple modern file-based cache implementation written in Go.
Inspired by [gokyle/filecache](https://github.com/gokyle/filecache).
## Install
```shell
# Requires Go 1.18 or later
$ go get -u github.com/0xc000022070/filecache@latest
```
## API
### Examples
#### Simple
```go
package main
import (
"fmt"
"os"
"time"
"github.com/0xc000022070/filecache"
)
func main() {
cache := filecache.New("showcase-1",
filecache.WithTTL(time.Hour),
filecache.WithMaxSize(filecache.Megabyte*100),
filecache.WithCheckInterval(time.Minute*3),
)
// if you don't want to destroy it from the FS
// use `cache.Shutdown()`.
defer cache.Destroy()
// Try to handle ErrToLarge, ErrInvalidKey, etc.
err := cache.Set("my-showcase-content.txt", []byte("heeey!"))
if err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
content, err := cache.Get("my-showcase-content.txt")
if err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
fmt.Fprintf(os.Stdout, "%s\n", content) // heeey!
}
```
#### Using generics
```go
package main
import (
"fmt"
"os"
"time"
"github.com/0xc000022070/filecache"
)
func main() {
cache := filecache.New("showcase-2",
filecache.WithTTL(time.Minute*5),
filecache.WithMaxSize(filecache.Gigabyte),
filecache.WithCheckInterval(time.Minute),
)
// It will not be destroyed from the FS, so it can be used in another program call.
defer cache.Shutdown()
type UserData struct {
Name string
Email string
}
users := []UserData{
{
Name: "John Doe",
Email: "john@doe.com",
},
{
Name: "Jane Doe",
Email: "jane@doe.com",
},
}
for _, user := range users {
key := fmt.Sprintf("user-%s", user.Email)
// (encoded as glob)
if err := filecache.SetEncoded(cache, key, user); err != nil {
fmt.Fprintln(os.Stderr, err)
}
user2, err := filecache.GetDecoded[UserData](cache, key)
if err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
fmt.Fprintf(os.Stdout, "%s <%s>\n", user2.Name, user2.Email)
}
if !cache.Exists(fmt.Sprintf("user-%s", users[0].Email)) {
fmt.Fprintln(os.Stderr, "user not found")
os.Exit(1)
}
}
```
## License
This project is licensed under the ISC License - see the [LICENSE](./LICENSE.md) file for details.