cache

package

v2.280.0 Latest Latest Go to latest Published: Feb 13, 2026 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/alexfalkowski/go-service

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cache provides cache abstractions, configuration, and drivers for go-service.

Index ¶

Variables
func Get[T any](ctx context.Context, key string) (*T, error)
func Persist[T any](ctx context.Context, key string, value *T, ttl time.Duration) error
func Register(c *Cache)
type Cache
- func NewCache(params CacheParams) *Cache
type CacheParams

Constants ¶

This section is empty.

Variables ¶

View Source

var Module = di.Module(
	di.Constructor(driver.NewDriver),
	di.Constructor(NewCache),
	di.Register(Register),
)

Module for fx.

Functions ¶

func Get ¶

func Get[T any](ctx context.Context, key string) (*T, error)

Get a value from key.

func Persist ¶

func Persist[T any](ctx context.Context, key string, value *T, ttl time.Duration) error

Persist a value to the key with a TTL.

func Register ¶

func Register(c *Cache)

Register the cache.

Types ¶

type Cache ¶

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

Cache allows marshaling and compressing items to the cache.

func NewCache ¶

func NewCache(params CacheParams) *Cache

NewCache from config.

func (*Cache) Close ¶

func (c *Cache) Close(_ context.Context) error

Close the cache.

func (*Cache) Get ¶

func (c *Cache) Get(_ context.Context, key string, value any) error

Get a cached value.

func (*Cache) Persist ¶

func (c *Cache) Persist(_ context.Context, key string, value any, ttl time.Duration) error

Persist a value with key and TTL.

func (*Cache) Remove ¶

func (c *Cache) Remove(_ context.Context, key string) error

Remove a cached key.

type CacheParams ¶ added in v2.50.0

type CacheParams struct {
	di.In
	Lifecycle  di.Lifecycle
	Config     *config.Config
	Encoder    *encoding.Map
	Pool       *sync.BufferPool
	Compressor *compress.Map
	Driver     driver.Driver
}

CacheParams for cache.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
config Package config provides cache configuration types for go-service.	Package config provides cache configuration types for go-service.
driver Package driver provides cache driver constructors for go-service.	Package driver provides cache driver constructors for go-service.

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