kingecg
/
go-cache
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Nicer spacing in library reference

This commit is contained in:
Patrick Mylund Nielsen 2012-01-03 12:26:08 +01:00
parent 9fbe1a4edd
commit 783e6df827
1 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README
View File

@ -78,51 +78,51 @@ will print:
Reference: Reference:
func New(de, ci time.Duration) *Cache func New(de, ci time.Duration) *Cache
Returns a new cache with a given default expiration duration and default cleanup Returns a new cache with a given default expiration duration and default cleanup
interval. If the expiration duration is less than 1, the items in the cache never interval. If the expiration duration is less than 1, the items in the cache never
expire and must be deleted manually. If the cleanup interval is less than one, expire and must be deleted manually. If the cleanup interval is less than one,
expired items are not deleted from the cache before their next lookup or before expired items are not deleted from the cache before their next lookup or before
calling DeleteExpired. calling DeleteExpired.
func (c *Cache) Set(k string, x interface{}, d time.Duration) func (c *Cache) Set(k string, x interface{}, d time.Duration)
Adds an item to the cache, replacing any existing item. If the duration is 0, the Adds an item to the cache, replacing any existing item. If the duration is 0, the
cache's default expiration time is used. If it is -1, the item never expires. cache's default expiration time is used. If it is -1, the item never expires.
func (c *Cache) Add(k string, x interface{}, d time.Duration) error func (c *Cache) Add(k string, x interface{}, d time.Duration) error
Adds an item to the cache only if an item doesn't already exist for the given key, Adds an item to the cache only if an item doesn't already exist for the given key,
or if the existing item has expired. Returns an error if not. or if the existing item has expired. Returns an error if not.
func (c *Cache) Replace(k string, x interface{}, d time.Duration) error func (c *Cache) Replace(k string, x interface{}, d time.Duration) error
Sets a new value for the cache item only if it already exists. Returns an error if Sets a new value for the cache item only if it already exists. Returns an error if
it does not. it does not.
func (c *Cache) Get(k string) (interface{}, bool) func (c *Cache) Get(k string) (interface{}, bool)
Gets an item from the cache. Returns the item or nil, and a bool indicating whether Gets an item from the cache. Returns the item or nil, and a bool indicating whether
the given key was found in the cache. the given key was found in the cache.
func (c *Cache) Increment(k string, n int64) error func (c *Cache) Increment(k string, n int64) error
Increment an item of type int, int8, int16, int32, int64, uintptr, uint, uint8, Increment an item of type int, int8, int16, int32, int64, uintptr, uint, uint8,
uint32, or uint64, float32 or float64 by n. Returns an error if the item's value uint32, or uint64, float32 or float64 by n. Returns an error if the item's value
is not an integer, if it was not found, or if it is not possible to increment it is not an integer, if it was not found, or if it is not possible to increment it
by n. Passing a negative number will cause the item to be decremented. by n. Passing a negative number will cause the item to be decremented.
func (c *Cache) IncrementFloat(k string, n float64) error func (c *Cache) IncrementFloat(k string, n float64) error
Increment an item of type int, int8, int16, int32, int64, uintptr, uint, uint8, Increment an item of type int, int8, int16, int32, int64, uintptr, uint, uint8,
uint32, uint64, float32 or float64 by n. Returns an error if the item's value is uint32, uint64, float32 or float64 by n. Returns an error if the item's value is
not an integer, if it was not found, or if it is not possible to increment it by not an integer, if it was not found, or if it is not possible to increment it by
n. Passing a negative number will cause the item to be decremented. n. Passing a negative number will cause the item to be decremented.
func (c *Cache) Decrement(k string, n int64) error func (c *Cache) Decrement(k string, n int64) error
Decrement an item of type int, int8, int16, int32, int64, uintptr, uint, uint8, Decrement an item of type int, int8, int16, int32, int64, uintptr, uint, uint8,
uint32, or uint64, float32 or float64 by n. Returns an error if the item's value uint32, or uint64, float32 or float64 by n. Returns an error if the item's value
is not an integer, if it was not found, or if it is not possible to decrement it is not an integer, if it was not found, or if it is not possible to decrement it
by n. by n.
func (c *Cache) Delete(k string) func (c *Cache) Delete(k string)
Deletes an item from the cache. Does nothing if the item does not exist in the cache. Deletes an item from the cache. Does nothing if the item does not exist in the cache.
func (c *Cache) DeleteExpired() func (c *Cache) DeleteExpired()
Deletes all expired items from the cache. Deletes all expired items from the cache.
func (c *Cache) Flush() func (c *Cache) Flush()
Deletes all items from the cache. Deletes all items from the cache.