README
¶
Stash
A Go package for disk-based blob cache.
Installation
Install Stash using the go get command:
$ go get github.com/chikamim/stash
The only dependency is the Go distribution.
Motivation
This package allows us to reduce calls to our blob storage by caching the most recently used blobs to disk.
Documentation
Contributing
Contributions are welcome.
License
Stash is available under the BSD (3-Clause) License.
Disclaimer
The package is a work in progress. It is functional, but does not claim to be production-ready. Please use it at your own risk.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( ErrNotFound = errors.New("not found") ErrBadDir = errors.New("invalid directory") ErrBadSize = errors.New("storage size must be greater then zero") ErrBadCap = errors.New("file number must be greater then zero") ErrTooLarge = errors.New("file size must be less or equal storage size") )
Functions ¶
func NewDeflateWriter ¶
func NewDeflateWriter(w io.WriteCloser) io.WriteCloser
Types ¶
type Cache ¶
type Cache struct {
// contains filtered or unexported fields
}
func New ¶
New creates a Cache backed by dir on disk. The cache allows at most "cap" files of total size "size". If "useDeflate" is true, blobs will be compressed by lz4 for reduce disk usage.
func (*Cache) Get ¶
func (c *Cache) Get(key string) (io.ReadCloser, error)
Get returns a reader for a blob in the cache, or ErrNotFound otherwise.
func (*Cache) PutFile ¶
PutFile adds the contents of a file path as a blog to the cache. The source file will be moved or deleted.
type DeflateReader ¶
type DeflateReader struct {
// contains filtered or unexported fields
}
func NewDeflateReader ¶
func NewDeflateReader(r io.ReadCloser) *DeflateReader
func (*DeflateReader) Close ¶
func (d *DeflateReader) Close() error
Source Files