cache

package

v1.6.0 Latest Latest Go to latest Published: Feb 8, 2023 License: MIT Imports: 13 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

Repository

github.com/sphireinc/mantis

Links

Open Source Insights

README ¶

Sphire Mantis::Cache

The Cache package of Mantis provides helpers for Big Cache, Memcache, and a custom Disk Cache implementation.

Documentation ¶

Index ¶

Constants
type BigCache
- func (b *BigCache) Init() error
type DiskCache
- func New() *DiskCache
- func (D *DiskCache) Get(key string) (any, error)
- func (D *DiskCache) Set(key string, data any) error
type MemCache
- func NewMemCache(algorithm memory.Algorithm, capacity int, refreshKey string, ...) MemCache
- func (m *MemCache) Init() error
- func (m *MemCache) String() string
type Memory
- func NewMemoryCache(capacity int64, expiry string) *Memory

Constants ¶

View Source

const (
	RELEASED = iota
	UPDATED
	CREATED
	NOOP
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BigCache ¶

type BigCache struct {
	Cache  *bigcache.BigCache
	Config bigcache.Config
}

BigCache primary struct with bigcache pointer and config

func (*BigCache) Init ¶

func (b *BigCache) Init() error

Init creates a new Allegro BigCache based on b.Config

type DiskCache ¶

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

DiskCache primary struct with an array of diskCache (key:filename) and the primary directory

func New ¶

func New() *DiskCache

New creates a new DiskCache using the tmp directory

func (*DiskCache) Get ¶

func (D *DiskCache) Get(key string) (any, error)

Get the data pointed to by a key

func (*DiskCache) Set ¶

func (D *DiskCache) Set(key string, data any) error

Set some data to a given key

type MemCache ¶

type MemCache struct {
	Client     *cache.Client
	Algorithm  memory.Algorithm
	Capacity   int
	RefreshKey string
	// contains filtered or unexported fields
}

MemCache primary struct for victorspringers http-cache

func NewMemCache ¶

func NewMemCache(algorithm memory.Algorithm, capacity int, refreshKey string, cacheTime time.Duration) MemCache

NewMemCache creates a new MemCache instance

func (*MemCache) Init ¶

func (m *MemCache) Init() error

Init starts our in-memory cache.

func (*MemCache) String ¶

func (m *MemCache) String() string

type Memory ¶ added in v1.5.6

type Memory struct {
	Config memoryConfig
	// contains filtered or unexported fields
}

func NewMemoryCache ¶ added in v1.5.6

func NewMemoryCache(capacity int64, expiry string) *Memory

func (*Memory) Get ¶ added in v1.5.6

func (m *Memory) Get(key uint64) (any, bool)

func (*Memory) Release ¶ added in v1.5.6

func (m *Memory) Release(key uint64)

func (*Memory) Set ¶ added in v1.5.6

func (m *Memory) Set(key uint64, value any, expiration time.Time)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL