timed

Documentation

Index

• Variables
• type Cache
  • func NewCache() *Cache
  • func (c *Cache) Delete(key string)
  • func (c *Cache) Get(key string) (interface{}, bool)
  • func (c *Cache) Has(key string) bool
  • func (c *Cache) Set(key string, item *Item) error
  • func (c *Cache) UpdateExpiresAt(key string, expiresAt time.Time) error
  • func (c *Cache) UpdateValue(key string, value interface{}) error
• type Item
  • func NewItem(value interface{}, expiresAt time.Time) *Item
  • func (i *Item) GetExpiresAt() time.Time
  • func (i *Item) GetValue() interface{}
  • func (i *Item) HasExpired() bool
  • func (i *Item) SetExpiresAt(expiresAt time.Time)
  • func (i *Item) SetValue(value interface{})

Variables

var (
	ErrItemHasExpired = errors.New("item has expired")
)

Types

type Cache

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

Cache represents an in-memory cache

func NewCache

func NewCache() *Cache

NewCache creates a new Cache instance

func (*Cache) Delete

func (c *Cache) Delete(key string)

Delete removes a value from the cache

func (*Cache) Get

func (c *Cache) Get(key string) (interface{}, bool)

Get retrieves a value from the cache

func (*Cache) Has

func (c *Cache) Has(key string) bool

Has checks if the cache contains a key

func (*Cache) Set

func (c *Cache) Set(key string, item *Item) error

Set adds the item to the cache

func (*Cache) UpdateExpiresAt

func (c *Cache) UpdateExpiresAt(key string, expiresAt time.Time) error

UpdateExpiresAt updates the expiration time of an item in the cache

func (*Cache) UpdateValue

func (c *Cache) UpdateValue(key string, value interface{}) error

UpdateValue updates the value of an item in the cache

type Item

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

Item represents a cached value with an expiration time

func NewItem

func NewItem(value interface{}, expiresAt time.Time) *Item

NewItem creates a new cache item

func (*Item) GetExpiresAt

func (i *Item) GetExpiresAt() time.Time

GetExpiresAt returns the expiration time of the cached value

func (*Item) GetValue

func (i *Item) GetValue() interface{}

GetValue returns the cached value

func (*Item) HasExpired

func (i *Item) HasExpired() bool

HasExpired returns true if the cached value has expired

func (*Item) SetExpiresAt

func (i *Item) SetExpiresAt(expiresAt time.Time)

SetExpiresAt sets the expiration time of the cached value

func (*Item) SetValue

func (i *Item) SetValue(value interface{})

SetValue sets the cached value