redis

package
v2.0.1-0...-03295ea Latest Latest
Warning

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

 Go to latest Published: Nov 14, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package redis is a generated GoMock package.

Index

Constants

View Source 
const (
	// TTLKeyNotFound is redis return status to TTL command that simbolize a key not found
	TTLKeyNotFound = -2
	// KeyWithoutTTL is redis return status to TTL command that simbolize a key without TTL set
	KeyWithoutTTL = -1
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client interface {
	Del(ctx context.Context, key string) error
	Exists(ctx context.Context, key string) error
	ExpireAt(ctx context.Context, key string, time time.Time) error
	Ping(ctx context.Context) (string, error)
	SAdd(ctx context.Context, key, member string) error
	SMembers(ctx context.Context, key string) ([]string, error)
	SRem(ctx context.Context, key string, members ...string) error
	TTL(ctx context.Context, key string) (time.Duration, error)
	ZAdd(ctx context.Context, key string, members ...*Member) error
	ZCard(ctx context.Context, key string) (int64, error)
	ZIncrBy(ctx context.Context, key, member string, increment float64) error
	ZRange(ctx context.Context, key string, start, stop int64) ([]*Member, error)
	ZRangeByScore(ctx context.Context, key string, min, max string, offset, count int64) ([]string, error)
	ZRank(ctx context.Context, key, member string) (int64, error)
	ZRem(ctx context.Context, key string, members ...string) error
	ZRevRange(ctx context.Context, key string, start, stop int64) ([]*Member, error)
	ZRevRangeByScore(ctx context.Context, key string, min, max string, offset, count int64) ([]string, error)
	ZRevRank(ctx context.Context, key, member string) (int64, error)
	ZScore(ctx context.Context, key, member string) (float64, error)
}

Client interface define wich redis methods will be used by leaderboard module

func NewClusterClient 

func NewClusterClient(clusterOptions ClusterOptions) Client

NewClusterClient returns a new redis cluster client instance

func NewStandaloneClient 

func NewStandaloneClient(options StandaloneOptions) Client

NewStandaloneClient returns a new redis standalone client instance

type ClusterOptions 

type ClusterOptions struct {
	Addrs    []string
	Password string
}

ClusterOptions define configuration parameters to instantiate a new ClusterClient

type GeneralError 

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

GeneralError create a redis error that is not handled

func NewGeneralError 

func NewGeneralError(msg string) *GeneralError

NewGeneralError create a new redis error that isnt handled

func (*GeneralError) Error 

func (ue *GeneralError) Error() string

type KeyNotFoundError 

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

KeyNotFoundError is an error throw when key is not in redis

func NewKeyNotFoundError 

func NewKeyNotFoundError(key string) *KeyNotFoundError

NewKeyNotFoundError create a new KeyNotFoundError

func (*KeyNotFoundError) Error 

func (knfe *KeyNotFoundError) Error() string

type Member 

type Member struct {
	Member string
	Score  float64
}

Member is a struct to be used by sorted set range operations

type MemberNotFoundError 

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

MemberNotFoundError is an error throw when key has not Member

func NewMemberNotFoundError 

func NewMemberNotFoundError(key, member string) *MemberNotFoundError

NewMemberNotFoundError create a new KeyNotFoundError

func (*MemberNotFoundError) Error 

func (mnfe *MemberNotFoundError) Error() string

type MockRedis 

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

MockRedis is a mock of Redis interface.

func NewMockRedis 

func NewMockRedis(ctrl *gomock.Controller) *MockRedis

NewMockRedis creates a new mock instance.

func (*MockRedis) Del 

func (m *MockRedis) Del(ctx context.Context, key string) error

Del mocks base method.

func (*MockRedis) EXPECT 

func (m *MockRedis) EXPECT() *MockRedisMockRecorder

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

func (*MockRedis) Exists 

func (m *MockRedis) Exists(ctx context.Context, key string) error

Exists mocks base method.

func (*MockRedis) ExpireAt 

func (m *MockRedis) ExpireAt(ctx context.Context, key string, time time.Time) error

ExpireAt mocks base method.

func (*MockRedis) Ping 

func (m *MockRedis) Ping(ctx context.Context) (string, error)

Ping mocks base method.

func (*MockRedis) SAdd 

func (m *MockRedis) SAdd(ctx context.Context, key, member string) error

SAdd mocks base method.

func (*MockRedis) SMembers 

func (m *MockRedis) SMembers(ctx context.Context, key string) ([]string, error)

SMembers mocks base method.

func (*MockRedis) SRem 

func (m *MockRedis) SRem(ctx context.Context, key string, members ...string) error

SRem mocks base method.

func (*MockRedis) TTL 

func (m *MockRedis) TTL(ctx context.Context, key string) (time.Duration, error)

TTL mocks base method.

func (*MockRedis) ZAdd 

func (m *MockRedis) ZAdd(ctx context.Context, key string, members ...*Member) error

ZAdd mocks base method.

func (*MockRedis) ZCard 

func (m *MockRedis) ZCard(ctx context.Context, key string) (int64, error)

ZCard mocks base method.

func (*MockRedis) ZIncrBy 

func (m *MockRedis) ZIncrBy(ctx context.Context, key, member string, increment float64) error

ZIncrBy mocks base method.

func (*MockRedis) ZRange 

func (m *MockRedis) ZRange(ctx context.Context, key string, start, stop int64) ([]*Member, error)

ZRange mocks base method.

func (*MockRedis) ZRangeByScore 

func (m *MockRedis) ZRangeByScore(ctx context.Context, key, min, max string, offset, count int64) ([]string, error)

ZRangeByScore mocks base method.

func (*MockRedis) ZRank 

func (m *MockRedis) ZRank(ctx context.Context, key, member string) (int64, error)

ZRank mocks base method.

func (*MockRedis) ZRem 

func (m *MockRedis) ZRem(ctx context.Context, key string, members ...string) error

ZRem mocks base method.

func (*MockRedis) ZRevRange 

func (m *MockRedis) ZRevRange(ctx context.Context, key string, start, stop int64) ([]*Member, error)

ZRevRange mocks base method.

func (*MockRedis) ZRevRangeByScore 

func (m *MockRedis) ZRevRangeByScore(ctx context.Context, key, min, max string, offset, count int64) ([]string, error)

ZRevRangeByScore mocks base method.

func (*MockRedis) ZRevRank 

func (m *MockRedis) ZRevRank(ctx context.Context, key, member string) (int64, error)

ZRevRank mocks base method.

func (*MockRedis) ZScore 

func (m *MockRedis) ZScore(ctx context.Context, key, member string) (float64, error)

ZScore mocks base method.

type MockRedisMockRecorder 

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

MockRedisMockRecorder is the mock recorder for MockRedis.

func (*MockRedisMockRecorder) Del 

func (mr *MockRedisMockRecorder) Del(ctx, key interface{}) *gomock.Call

Del indicates an expected call of Del.

func (*MockRedisMockRecorder) Exists 

func (mr *MockRedisMockRecorder) Exists(ctx, key interface{}) *gomock.Call

Exists indicates an expected call of Exists.

func (*MockRedisMockRecorder) ExpireAt 

func (mr *MockRedisMockRecorder) ExpireAt(ctx, key, time interface{}) *gomock.Call

ExpireAt indicates an expected call of ExpireAt.

func (*MockRedisMockRecorder) Ping 

func (mr *MockRedisMockRecorder) Ping(ctx interface{}) *gomock.Call

Ping indicates an expected call of Ping.

func (*MockRedisMockRecorder) SAdd 

func (mr *MockRedisMockRecorder) SAdd(ctx, key, member interface{}) *gomock.Call

SAdd indicates an expected call of SAdd.

func (*MockRedisMockRecorder) SMembers 

func (mr *MockRedisMockRecorder) SMembers(ctx, key interface{}) *gomock.Call

SMembers indicates an expected call of SMembers.

func (*MockRedisMockRecorder) SRem 

func (mr *MockRedisMockRecorder) SRem(ctx, key interface{}, members ...interface{}) *gomock.Call

SRem indicates an expected call of SRem.

func (*MockRedisMockRecorder) TTL 

func (mr *MockRedisMockRecorder) TTL(ctx, key interface{}) *gomock.Call

TTL indicates an expected call of TTL.

func (*MockRedisMockRecorder) ZAdd 

func (mr *MockRedisMockRecorder) ZAdd(ctx, key interface{}, members ...interface{}) *gomock.Call

ZAdd indicates an expected call of ZAdd.

func (*MockRedisMockRecorder) ZCard 

func (mr *MockRedisMockRecorder) ZCard(ctx, key interface{}) *gomock.Call

ZCard indicates an expected call of ZCard.

func (*MockRedisMockRecorder) ZIncrBy 

func (mr *MockRedisMockRecorder) ZIncrBy(ctx, key, member, increment interface{}) *gomock.Call

ZIncrBy indicates an expected call of ZIncrBy.

func (*MockRedisMockRecorder) ZRange 

func (mr *MockRedisMockRecorder) ZRange(ctx, key, start, stop interface{}) *gomock.Call

ZRange indicates an expected call of ZRange.

func (*MockRedisMockRecorder) ZRangeByScore 

func (mr *MockRedisMockRecorder) ZRangeByScore(ctx, key, min, max, offset, count interface{}) *gomock.Call

ZRangeByScore indicates an expected call of ZRangeByScore.

func (*MockRedisMockRecorder) ZRank 

func (mr *MockRedisMockRecorder) ZRank(ctx, key, member interface{}) *gomock.Call

ZRank indicates an expected call of ZRank.

func (*MockRedisMockRecorder) ZRem 

func (mr *MockRedisMockRecorder) ZRem(ctx, key interface{}, members ...interface{}) *gomock.Call

ZRem indicates an expected call of ZRem.

func (*MockRedisMockRecorder) ZRevRange 

func (mr *MockRedisMockRecorder) ZRevRange(ctx, key, start, stop interface{}) *gomock.Call

ZRevRange indicates an expected call of ZRevRange.

func (*MockRedisMockRecorder) ZRevRangeByScore 

func (mr *MockRedisMockRecorder) ZRevRangeByScore(ctx, key, min, max, offset, count interface{}) *gomock.Call

ZRevRangeByScore indicates an expected call of ZRevRangeByScore.

func (*MockRedisMockRecorder) ZRevRank 

func (mr *MockRedisMockRecorder) ZRevRank(ctx, key, member interface{}) *gomock.Call

ZRevRank indicates an expected call of ZRevRank.

func (*MockRedisMockRecorder) ZScore 

func (mr *MockRedisMockRecorder) ZScore(ctx, key, member interface{}) *gomock.Call

ZScore indicates an expected call of ZScore.

type StandaloneOptions 

type StandaloneOptions struct {
	Host     string
	Port     int
	Password string
	DB       int
}

StandaloneOptions define configuration parameters to instantiate a new StandaloneClient

type TTLNotFoundError 

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

TTLNotFoundError is an error throw when key has not TTL

func NewTTLNotFoundError 

func NewTTLNotFoundError(key string) *TTLNotFoundError

NewTTLNotFoundError create a new KeyNotFoundError

func (*TTLNotFoundError) Error 

func (knfe *TTLNotFoundError) Error() 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.