store

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 25, 2025 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

Package store is a generated GoMock package.

Index

Constants

View Source 
const NOT_FOUND_ERR string = "value not found in store"

NOT_FOUND_ERR is the error message for "value not found in store"

Variables

This section is empty.

Functions

func NotFoundWithCause 

func NotFoundWithCause(e error) error

NotFoundWithCause creates a new NotFound error with a cause.

Types

type InvalidateOption 

type InvalidateOption func(o *InvalidateOptions)

InvalidateOption represents a cache invalidation function.

func WithInvalidateTags 

func WithInvalidateTags(tags []string) InvalidateOption

WithInvalidateTags allows setting the invalidate tags.

type InvalidateOptions 

type InvalidateOptions struct {
	Tags []string
}

func ApplyInvalidateOptions 

func ApplyInvalidateOptions(opts ...InvalidateOption) *InvalidateOptions

func ApplyInvalidateOptionsWithDefault 

func ApplyInvalidateOptionsWithDefault(defaultOptions *InvalidateOptions, opts ...InvalidateOption) *InvalidateOptions

type InvalidateOptionsMatcher 

type InvalidateOptionsMatcher struct {
	Tags []string
}

func (InvalidateOptionsMatcher) Matches 

func (m InvalidateOptionsMatcher) Matches(x interface{}) bool

func (InvalidateOptionsMatcher) String 

func (m InvalidateOptionsMatcher) String() string

type MockStore 

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

MockStore is a mock of Store interface.

func NewMockStore 

func NewMockStore(ctrl *gomock.Controller) *MockStore

NewMockStore creates a new mock instance.

func (*MockStore) Clear 

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

Clear mocks base method.

func (*MockStore) Delete 

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

Delete mocks base method.

func (*MockStore) EXPECT 

func (m *MockStore) EXPECT() *MockStoreMockRecorder

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

func (*MockStore) Get 

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

Get mocks base method.

func (*MockStore) GetType 

func (m *MockStore) GetType() string

GetType mocks base method.

func (*MockStore) GetWithTTL 

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

GetWithTTL mocks base method.

func (*MockStore) Invalidate 

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

Invalidate mocks base method.

func (*MockStore) Set 

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

Set mocks base method.

type MockStoreMockRecorder 

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

MockStoreMockRecorder is the mock recorder for MockStore.

func (*MockStoreMockRecorder) Clear 

func (mr *MockStoreMockRecorder) Clear(ctx any) *gomock.Call

Clear indicates an expected call of Clear.

func (*MockStoreMockRecorder) Delete 

func (mr *MockStoreMockRecorder) Delete(ctx, key any) *gomock.Call

Delete indicates an expected call of Delete.

func (*MockStoreMockRecorder) Get 

func (mr *MockStoreMockRecorder) Get(ctx, key any) *gomock.Call

Get indicates an expected call of Get.

func (*MockStoreMockRecorder) GetType 

func (mr *MockStoreMockRecorder) GetType() *gomock.Call

GetType indicates an expected call of GetType.

func (*MockStoreMockRecorder) GetWithTTL 

func (mr *MockStoreMockRecorder) GetWithTTL(ctx, key any) *gomock.Call

GetWithTTL indicates an expected call of GetWithTTL.

func (*MockStoreMockRecorder) Invalidate 

func (mr *MockStoreMockRecorder) Invalidate(ctx any, options ...any) *gomock.Call

Invalidate indicates an expected call of Invalidate.

func (*MockStoreMockRecorder) Set 

func (mr *MockStoreMockRecorder) Set(ctx, key, value any, options ...any) *gomock.Call

Set indicates an expected call of Set.

type NotFound 

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

NotFound is an error type representing a "value not found" error.

func (NotFound) Cause 

func (e NotFound) Cause() error

Cause returns the underlying cause of the NotFound error.

func (NotFound) Error 

func (e NotFound) Error() string

Error returns the error message for the NotFound error.

func (NotFound) Is 

func (e NotFound) Is(err error) bool

Is checks if the given error is a NotFound error.

func (NotFound) Unwrap 

func (e NotFound) Unwrap() error

Unwrap returns the underlying cause of the NotFound error.

type Option 

type Option func(o *Options)

Option represents a store option function.

func WithClientSideCaching 

func WithClientSideCaching(clientSideCacheExpiration time.Duration) Option

WithClientSideCaching allows setting the client side caching, enabled by default Currently to be used by Rueidis(redis) library only.

func WithCost 

func WithCost(cost int64) Option

WithCost allows setting the memory capacity used by the item when setting a value. Actually it seems to be used by Ristretto library only.

func WithExpiration 

func WithExpiration(expiration time.Duration) Option

WithExpiration allows to specify an expiration time when setting a value.

func WithSynchronousSet 

func WithSynchronousSet() Option

WithSynchronousSet allows setting the behavior when setting a value, whether to wait until all buffered writes have been applied or not. Currently to be used by Ristretto library only.

func WithTags 

func WithTags(tags []string) Option

WithTags allows to specify associated tags to the current value.

type Options 

type Options struct {
	SynchronousSet            bool
	Cost                      int64
	Expiration                time.Duration
	Tags                      []string
	ClientSideCacheExpiration time.Duration
}

func ApplyOptions 

func ApplyOptions(opts ...Option) *Options

func ApplyOptionsWithDefault 

func ApplyOptionsWithDefault(defaultOptions *Options, opts ...Option) *Options

func (*Options) IsEmpty 

func (o *Options) IsEmpty() bool

type OptionsMatcher 

type OptionsMatcher struct {
	Cost       int64
	Expiration time.Duration
	Tags       []string
}

func (OptionsMatcher) Matches 

func (m OptionsMatcher) Matches(x interface{}) bool

func (OptionsMatcher) String 

func (m OptionsMatcher) String() string

type Store 

type Store 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 ...Option) error
	Delete(ctx context.Context, key any) error
	Invalidate(ctx context.Context, options ...InvalidateOption) error
	Clear(ctx context.Context) error
	GetType() string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.