The highest tagged major version is v3.

memory

package

v2.2.2+incompatible Latest Latest Go to latest Published: Nov 7, 2018 License: MIT Imports: 7 Imported by: 83

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

This section is empty.

This section is empty.

func NewStore() limiter.Store

NewStore creates a new instance of memory store with defaults.

func NewStoreWithOptions(options limiter.StoreOptions) limiter.Store

NewStoreWithOptions creates a new instance of memory store with options.

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

Cache contains a collection of counters.

func (cache *Cache) Clean()

Clean will deleted any expired keys.

func (cache *Cache) Get(key string, duration time.Duration) (int64, time.Time)

Get returns key's value and expiration.

func (cache *Cache) Increment(key string, value int64, duration time.Duration) (int64, time.Time)

Increment increments given value on key. If key is undefined or expired, it will create it.

type CacheWrapper struct {
	*Cache
}

CacheWrapper is used to ensure that the underlying cleaner goroutine used to clean expired keys will not prevent Cache from being garbage collected.

func NewCache(cleanInterval time.Duration) *CacheWrapper

NewCache returns a new cache.

type Counter struct {
	Value      int64
	Expiration int64
}

Counter is a simple counter with an optional expiration.

func (counter Counter) Expired() bool

Expired returns true if the counter has expired.

type Store struct {
	// Prefix used for the key.
	Prefix string
	// contains filtered or unexported fields
}

Store is the in-memory store.

func (store *Store) Get(ctx context.Context, key string, rate limiter.Rate) (limiter.Context, error)

Get returns the limit for given identifier.

func (store *Store) Peek(ctx context.Context, key string, rate limiter.Rate) (limiter.Context, error)

Peek returns the limit for given identifier, without modification on current values.