cache

Documentation

Index

• Constants
• type Application
  • func NewApplication(store string) *Application
  • func (app *Application) Store(name string) cache.Driver
• type Lock
  • func NewLock(instance contractscache.Driver, key string, t ...time.Duration) *Lock
  • func (r *Lock) Block(t time.Duration, callback ...func()) bool
  • func (r *Lock) ForceRelease() bool
  • func (r *Lock) Get(callback ...func()) bool
  • func (r *Lock) Release() bool
• type Memory
  • func NewMemory() (*Memory, error)
  • func (r *Memory) Add(key string, value any, t time.Duration) bool
  • func (r *Memory) Decrement(key string, value ...int) (int, error)
  • func (r *Memory) Flush() bool
  • func (r *Memory) Forever(key string, value any) bool
  • func (r *Memory) Forget(key string) bool
  • func (r *Memory) Get(key string, def ...any) any
  • func (r *Memory) GetBool(key string, def ...bool) bool
  • func (r *Memory) GetInt(key string, def ...int) int
  • func (r *Memory) GetInt64(key string, def ...int64) int64
  • func (r *Memory) GetString(key string, def ...string) string
  • func (r *Memory) Has(key string) bool
  • func (r *Memory) Increment(key string, value ...int) (int, error)
  • func (r *Memory) Lock(key string, t ...time.Duration) contractscache.Lock
  • func (r *Memory) Pull(key string, def ...any) any
  • func (r *Memory) Put(key string, value any, t time.Duration) error
  • func (r *Memory) Remember(key string, seconds time.Duration, callback func() any) (any, error)
  • func (r *Memory) RememberForever(key string, callback func() any) (any, error)
  • func (r *Memory) WithContext(ctx context.Context) contractscache.Driver
• type Redis
  • func NewRedis(ctx context.Context, connection string) (*Redis, error)
  • func (r *Redis) Add(key string, value any, t time.Duration) bool
  • func (r *Redis) Decrement(key string, value ...int) (int, error)
  • func (r *Redis) Flush() bool
  • func (r *Redis) Forever(key string, value any) bool
  • func (r *Redis) Forget(key string) bool
  • func (r *Redis) Get(key string, def ...any) any
  • func (r *Redis) GetBool(key string, def ...bool) bool
  • func (r *Redis) GetInt(key string, def ...int) int
  • func (r *Redis) GetInt64(key string, def ...int64) int64
  • func (r *Redis) GetString(key string, def ...string) string
  • func (r *Redis) Has(key string) bool
  • func (r *Redis) Increment(key string, value ...int) (int, error)
  • func (r *Redis) Lock(key string, t ...time.Duration) cache.Lock
  • func (r *Redis) Pull(key string, def ...any) any
  • func (r *Redis) Put(key string, value any, t time.Duration) error
  • func (r *Redis) Remember(key string, seconds time.Duration, callback func() any) (any, error)
  • func (r *Redis) RememberForever(key string, callback func() any) (any, error)
  • func (r *Redis) WithContext(ctx context.Context) cache.Driver
• type ServiceProvider
  • func (database *ServiceProvider) Boot()
  • func (database *ServiceProvider) Register()

Constants

const NoExpiration time.Duration = 0

Types

type Application

type Application struct {
	cache.Driver
	// contains filtered or unexported fields
}

func NewApplication

func NewApplication(store string) *Application

func (*Application) Store

func (app *Application) Store(name string) cache.Driver

type Lock

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

func NewLock

func NewLock(instance contractscache.Driver, key string, t ...time.Duration) *Lock

func (*Lock) Block

func (r *Lock) Block(t time.Duration, callback ...func()) bool

func (*Lock) ForceRelease

func (r *Lock) ForceRelease() bool

func (*Lock) Get

func (r *Lock) Get(callback ...func()) bool

func (*Lock) Release

func (r *Lock) Release() bool

type Memory

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

func NewMemory

func NewMemory() (*Memory, error)

func (*Memory) Add

func (r *Memory) Add(key string, value any, t time.Duration) bool

Add Driver an item in the cache if the key does not exist.

func (*Memory) Decrement

func (r *Memory) Decrement(key string, value ...int) (int, error)

func (*Memory) Flush

func (r *Memory) Flush() bool

Flush Remove all items from the cache.

func (*Memory) Forever

func (r *Memory) Forever(key string, value any) bool

Forever Driver an item in the cache indefinitely.

func (*Memory) Forget

func (r *Memory) Forget(key string) bool

Forget Remove an item from the cache.

func (*Memory) Get

func (r *Memory) Get(key string, def ...any) any

Get Retrieve an item from the cache by key.

func (*Memory) GetBool

func (r *Memory) GetBool(key string, def ...bool) bool

func (*Memory) GetInt

func (r *Memory) GetInt(key string, def ...int) int

func (*Memory) GetInt64

func (r *Memory) GetInt64(key string, def ...int64) int64

func (*Memory) GetString

func (r *Memory) GetString(key string, def ...string) string

func (*Memory) Has

func (r *Memory) Has(key string) bool

Has Check an item exists in the cache.

func (*Memory) Increment

func (r *Memory) Increment(key string, value ...int) (int, error)

func (*Memory) Lock

func (r *Memory) Lock(key string, t ...time.Duration) contractscache.Lock

func (*Memory) Pull

func (r *Memory) Pull(key string, def ...any) any

Pull Retrieve an item from the cache and delete it.

func (*Memory) Put

func (r *Memory) Put(key string, value any, t time.Duration) error

Put Driver an item in the cache for a given number of seconds.

func (*Memory) Remember

func (r *Memory) Remember(key string, seconds time.Duration, callback func() any) (any, error)

Remember Get an item from the cache, or execute the given Closure and store the result.

func (*Memory) RememberForever

func (r *Memory) RememberForever(key string, callback func() any) (any, error)

RememberForever Get an item from the cache, or execute the given Closure and store the result forever.

func (*Memory) WithContext

func (r *Memory) WithContext(ctx context.Context) contractscache.Driver

type Redis

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

func NewRedis

func NewRedis(ctx context.Context, connection string) (*Redis, error)

func (*Redis) Add

func (r *Redis) Add(key string, value any, t time.Duration) bool

Add Driver an item in the cache if the key does not exist.

func (*Redis) Decrement

func (r *Redis) Decrement(key string, value ...int) (int, error)

func (*Redis) Flush

func (r *Redis) Flush() bool

Flush Remove all items from the cache.

func (*Redis) Forever

func (r *Redis) Forever(key string, value any) bool

Forever Driver an item in the cache indefinitely.

func (*Redis) Forget

func (r *Redis) Forget(key string) bool

Forget Remove an item from the cache.

func (*Redis) Get

func (r *Redis) Get(key string, def ...any) any

Get Retrieve an item from the cache by key.

func (*Redis) GetBool

func (r *Redis) GetBool(key string, def ...bool) bool

func (*Redis) GetInt

func (r *Redis) GetInt(key string, def ...int) int

func (*Redis) GetInt64

func (r *Redis) GetInt64(key string, def ...int64) int64

func (*Redis) GetString

func (r *Redis) GetString(key string, def ...string) string

func (*Redis) Has

func (r *Redis) Has(key string) bool

Has Check an item exists in the cache.

func (*Redis) Increment

func (r *Redis) Increment(key string, value ...int) (int, error)

func (*Redis) Lock

func (r *Redis) Lock(key string, t ...time.Duration) cache.Lock

func (*Redis) Pull

func (r *Redis) Pull(key string, def ...any) any

Pull Retrieve an item from the cache and delete it.

func (*Redis) Put

func (r *Redis) Put(key string, value any, t time.Duration) error

Put Driver an item in the cache for a given time.

func (*Redis) Remember

func (r *Redis) Remember(key string, seconds time.Duration, callback func() any) (any, error)

Remember Get an item from the cache, or execute the given Closure and store the result.

func (*Redis) RememberForever

func (r *Redis) RememberForever(key string, callback func() any) (any, error)

RememberForever Get an item from the cache, or execute the given Closure and store the result forever.

func (*Redis) WithContext

func (r *Redis) WithContext(ctx context.Context) cache.Driver

type ServiceProvider

type ServiceProvider struct {
}

func (*ServiceProvider) Boot

func (database *ServiceProvider) Boot()

func (*ServiceProvider) Register

func (database *ServiceProvider) Register()