store

Documentation

Index

• type ExpiringStore
  • func NewDefaultTimedStore[T any]() ExpiringStore[T]
  • func NewTimedStore[T any](duration time.Duration) ExpiringStore[T]
• type Set
  • func NewSet[T any]() Set[T]
• type Store
  • func NewStore[T any]() Store[T]
• type Timer
  • func NewTimer() *Timer

Types

type ExpiringStore

type ExpiringStore[T any] interface {
	// SetWithDuration adds the provided value with given key and duration to the store.
	// The stored value will be removed after the provided duration.
	SetWithDuration(key string, value *T, duration time.Duration)
	Store[T]
}

func NewDefaultTimedStore

func NewDefaultTimedStore[T any]() ExpiringStore[T]

func NewTimedStore

func NewTimedStore[T any](duration time.Duration) ExpiringStore[T]

type Set

type Set[T any] interface {
	Add(item *T)
	GetAll() []*T
	Remove(item *T)
	Clear()
	Contains(item *T) bool
	IsEmpty() bool
}

func NewSet

func NewSet[T any]() Set[T]

type Store

type Store[T any] interface {
	// Delete removes the stored struct related to given key.
	Delete(key string)
	// Set adds the provided value with given key to the store.
	Set(key string, value *T)
	// Get retrieves the value from the store by the given key.
	Get(key string) (*T, bool)
	// GetValues retrieves all values from the store.
	GetValues() []*T
}

func NewStore

func NewStore[T any]() Store[T]

type Timer

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

func NewTimer

func NewTimer() *Timer