diff --git a/README b/README index 38e5128..2125a76 100644 --- a/README +++ b/README @@ -141,16 +141,16 @@ func (c *Cache) Flush() Deletes all items from the cache. func (c *cache) Save(w io.Writer) error - Writes the cache's items using Gob to an io.Writer + Writes the cache's items (using Gob) to an io.Writer. func (c *cache) SaveFile(fname string) error Saves the cache's items to the given filename, creating the file if it doesn't exist, and overwriting it if it does. func (c *cache) Load(r io.Reader) error - Adds gob-serialized cache items from an io.Reader, excluding any items that - already exist in the current cache + Adds (Gob-serialized) cache items from an io.Reader, excluding any items that + already exist in the current cache. func (c *cache) LoadFile(fname string) error Loads and adds cache items from the given filename, excluding any items that - already exist in the current cache + already exist in the current cache, diff --git a/cache.go b/cache.go index bac11ad..d300aee 100644 --- a/cache.go +++ b/cache.go @@ -278,7 +278,7 @@ func (c *cache) DeleteExpired() { } } -// Writes the cache's items using Gob to an io.Writer +// Writes the cache's items (using Gob) to an io.Writer. func (c *cache) Save(w io.Writer) error { enc := gob.NewEncoder(w) @@ -300,7 +300,7 @@ were stored in cache, at https://github.com/pmylund/go-cache/issues/new`, x) } // Saves the cache's items to the given filename, creating the file if it -// doesn't exist, and overwriting it if it does +// doesn't exist, and overwriting it if it does. func (c *cache) SaveFile(fname string) error { fp, err := os.Create(fname) if err != nil { @@ -309,8 +309,8 @@ func (c *cache) SaveFile(fname string) error { return c.Save(fp) } -// Adds gob-serialized cache items from an io.Reader, excluding any items that -// already exist in the current cache +// Adds (Gob-serialized) cache items from an io.Reader, excluding any items that +// already exist in the current cache. func (c *cache) Load(r io.Reader) error { dec := gob.NewDecoder(r) items := map[string]*Item{} @@ -327,7 +327,7 @@ func (c *cache) Load(r io.Reader) error { } // Loads and adds cache items from the given filename, excluding any items that -// already exist in the current cache +// already exist in the current cache. func (c *cache) LoadFile(fname string) error { fp, err := os.Open(fname) if err != nil {