boltdbcache

package module

v1.0.1 Latest Latest Go to latest Published: Aug 1, 2023 License: MIT Imports: 1 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package boltdbcache provides a file system based cache backend for Greg Jones' httpcache using coreos/bbolt.

This section is empty.

This section is empty.

This section is empty.

type Cache struct {
	// contains filtered or unexported fields
}

Cache is an implementation of httpcache.Cache that uses a bolt database.

func New(path string, opts ...Option) (*Cache, error)

New returns a new Cache that uses a bolt database at the given path.

func NewWithDB(db *bolt.DB, opts ...Option) (*Cache, error)

NewWithDB returns a new Cache using the provided (and opened) bolt database.

func (c *Cache) Close() error

Close closes the underlying boltdb database.

func (c *Cache) Delete(key string)

Delete removes the response with the given key from the cache.

func (c *Cache) Get(key string) (resp []byte, ok bool)

Get retrieves the response corresponding to the given key if present.

func (c *Cache) Set(key string, resp []byte)

Set stores a response to the cache at the given key.

type Option func(*Cache)

An Option is a function that applies an option to a Cache.

func WithBucketName(name string) Option

WithBucketName is a functional option that sets the bucket name to use for this cache.