codec

package

v4.1.6 Latest Latest Go to latest Published: Apr 16, 2024 License: MIT Imports: 6 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/eko/gocache

Links

Open Source Insights

Documentation ¶

Overview ¶

Package codec is a generated GoMock package.

Index ¶

type Codec
- func New(store store.StoreInterface) *Codec
type CodecInterface
type MockCodecInterface
- func NewMockCodecInterface(ctrl *gomock.Controller) *MockCodecInterface
type MockCodecInterfaceMockRecorder
type Stats

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Codec ¶

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

Codec represents an instance of a cache store

func New ¶

func New(store store.StoreInterface) *Codec

New return a new codec instance

func (*Codec) Clear ¶

func (c *Codec) Clear(ctx context.Context) error

Clear resets all codec store data

func (*Codec) Delete ¶

func (c *Codec) Delete(ctx context.Context, key any) error

Delete allows to remove a value for a given key identifier

func (*Codec) Get ¶

func (c *Codec) Get(ctx context.Context, key any) (any, error)

Get allows to retrieve the value from a given key identifier

func (*Codec) GetStats ¶

func (c *Codec) GetStats() *Stats

GetStats returns some statistics about the current codec

func (*Codec) GetStore ¶

func (c *Codec) GetStore() store.StoreInterface

GetStore returns the store associated to this codec

func (*Codec) GetWithTTL ¶

func (c *Codec) GetWithTTL(ctx context.Context, key any) (any, time.Duration, error)

GetWithTTL allows to retrieve the value from a given key identifier and its corresponding TTL

func (*Codec) Invalidate ¶

func (c *Codec) Invalidate(ctx context.Context, options ...store.InvalidateOption) error

Invalidate invalidates some cach items from given options

func (*Codec) Set ¶

func (c *Codec) Set(ctx context.Context, key any, value any, options ...store.Option) error

Set allows to set a value for a given key identifier and also allows to specify an expiration time

type CodecInterface ¶

type CodecInterface interface {
	Get(ctx context.Context, key any) (any, error)
	GetWithTTL(ctx context.Context, key any) (any, time.Duration, error)
	Set(ctx context.Context, key any, value any, options ...store.Option) error
	Delete(ctx context.Context, key any) error
	Invalidate(ctx context.Context, options ...store.InvalidateOption) error
	Clear(ctx context.Context) error

	GetStore() store.StoreInterface
	GetStats() *Stats
}

CodecInterface represents an instance of a cache codec

type MockCodecInterface ¶

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

MockCodecInterface is a mock of CodecInterface interface.

func NewMockCodecInterface ¶

func NewMockCodecInterface(ctrl *gomock.Controller) *MockCodecInterface

NewMockCodecInterface creates a new mock instance.

func (*MockCodecInterface) Clear ¶

func (m *MockCodecInterface) Clear(ctx context.Context) error

Clear mocks base method.

func (*MockCodecInterface) Delete ¶

func (m *MockCodecInterface) Delete(ctx context.Context, key any) error

Delete mocks base method.

func (*MockCodecInterface) EXPECT ¶

func (m *MockCodecInterface) EXPECT() *MockCodecInterfaceMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockCodecInterface) Get ¶

func (m *MockCodecInterface) Get(ctx context.Context, key any) (any, error)

Get mocks base method.

func (*MockCodecInterface) GetStats ¶

func (m *MockCodecInterface) GetStats() *Stats

GetStats mocks base method.

func (*MockCodecInterface) GetStore ¶

func (m *MockCodecInterface) GetStore() store.StoreInterface

GetStore mocks base method.

func (*MockCodecInterface) GetWithTTL ¶

func (m *MockCodecInterface) GetWithTTL(ctx context.Context, key any) (any, time.Duration, error)

GetWithTTL mocks base method.

func (*MockCodecInterface) Invalidate ¶

func (m *MockCodecInterface) Invalidate(ctx context.Context, options ...store.InvalidateOption) error

Invalidate mocks base method.

func (*MockCodecInterface) Set ¶

func (m *MockCodecInterface) Set(ctx context.Context, key, value any, options ...store.Option) error

Set mocks base method.

type MockCodecInterfaceMockRecorder ¶

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

MockCodecInterfaceMockRecorder is the mock recorder for MockCodecInterface.

func (*MockCodecInterfaceMockRecorder) Clear ¶

func (mr *MockCodecInterfaceMockRecorder) Clear(ctx interface{}) *gomock.Call

Clear indicates an expected call of Clear.

func (*MockCodecInterfaceMockRecorder) Delete ¶

func (mr *MockCodecInterfaceMockRecorder) Delete(ctx, key interface{}) *gomock.Call

Delete indicates an expected call of Delete.

func (*MockCodecInterfaceMockRecorder) Get ¶

func (mr *MockCodecInterfaceMockRecorder) Get(ctx, key interface{}) *gomock.Call

Get indicates an expected call of Get.

func (*MockCodecInterfaceMockRecorder) GetStats ¶

func (mr *MockCodecInterfaceMockRecorder) GetStats() *gomock.Call

GetStats indicates an expected call of GetStats.

func (*MockCodecInterfaceMockRecorder) GetStore ¶

func (mr *MockCodecInterfaceMockRecorder) GetStore() *gomock.Call

GetStore indicates an expected call of GetStore.

func (*MockCodecInterfaceMockRecorder) GetWithTTL ¶

func (mr *MockCodecInterfaceMockRecorder) GetWithTTL(ctx, key interface{}) *gomock.Call

GetWithTTL indicates an expected call of GetWithTTL.

func (*MockCodecInterfaceMockRecorder) Invalidate ¶

func (mr *MockCodecInterfaceMockRecorder) Invalidate(ctx interface{}, options ...interface{}) *gomock.Call

Invalidate indicates an expected call of Invalidate.

func (*MockCodecInterfaceMockRecorder) Set ¶

func (mr *MockCodecInterfaceMockRecorder) Set(ctx, key, value interface{}, options ...interface{}) *gomock.Call

Set indicates an expected call of Set.

type Stats ¶

type Stats struct {
	Hits              int
	Miss              int
	SetSuccess        int
	SetError          int
	DeleteSuccess     int
	DeleteError       int
	InvalidateSuccess int
	InvalidateError   int
	ClearSuccess      int
	ClearError        int
}

Stats allows to returns some statistics of codec usage

Source Files ¶

View all Source files

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