cache

Documentation

Index

• Constants
• type C
  • func New(defaultExpiration time.Duration) *C
  • func (c *C) DeleteExpired()
  • func (c *C) Get(k string) (interface{}, bool)
  • func (c *C) Set(k string, x interface{}, d time.Duration)
• type Item
  • func (item Item) Expired() bool

Constants

const (
	// For use with functions that take an expiration time.
	NoExpiration time.Duration = -1
	// For use with functions that take an expiration time. Equivalent to
	// passing in the same expiration duration as was given to New() or
	// NewFrom() when the cache was created (e.g. 5 minutes.)
	DefaultExpiration time.Duration = 0
)

Types

type C

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

func New

func New(defaultExpiration time.Duration) *C

Return a new cache with a given default expiration duration and cleanup interval. If the expiration duration is less than one (or NoExpiration), the items in the cache never expire (by default), and must be deleted manually. If the cleanup interval is less than one, expired items are not deleted from the cache before calling c.DeleteExpired().

func (*C) DeleteExpired

func (c *C) DeleteExpired()

Delete all expired items from the cache.

func (*C) Get

func (c *C) Get(k string) (interface{}, bool)

func (*C) Set

func (c *C) Set(k string, x interface{}, d time.Duration)

type Item

type Item struct {
	Object     interface{}
	Expiration int64
}

func (Item) Expired

func (item Item) Expired() bool

Returns true if the item has expired.