implement interface function

cache/cache.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"reflect"
 	"strings"
+	"time"
 
 	"github.com/eko/gocache/codec"
 	"github.com/eko/gocache/store"
@@ -20,7 +21,7 @@ type Cache struct {
 	codec codec.CodecInterface
 }
 
-// New instanciates a new cache entry
+// New instantiates a new cache entry
 func New(store store.StoreInterface) *Cache {
 	return &Cache{
 		codec: codec.New(store),
@@ -33,6 +34,12 @@ func (c *Cache) Get(key interface{}) (interface{}, error) {
 	return c.codec.Get(cacheKey)
 }
 
+// GetWithTTL returns the object stored in cache and its corresponding TTL
+func (c *Cache) GetWithTTL(key interface{}) (interface{}, time.Duration, error) {
+	cacheKey := c.getCacheKey(key)
+	return c.codec.GetWithTTL(cacheKey)
+}
+
 // Set populates the cache item using the given key
 func (c *Cache) Set(key, object interface{}, options *store.Options) error {
 	cacheKey := c.getCacheKey(key)

codec/codec.go

@@ -1,6 +1,8 @@
 package codec
 
 import (
+	"time"
+
 	"github.com/eko/gocache/store"
 )
 
@@ -45,6 +47,19 @@ func (c *Codec) Get(key interface{}) (interface{}, error) {
 	return val, err
 }
 
+// GetWithTTL allows to retrieve the value from a given key identifier and its corresponding TTL
+func (c *Codec) GetWithTTL(key interface{}) (interface{}, time.Duration, error) {
+	val, ttl, err := c.store.GetWithTTL(key)
+
+	if err == nil {
+		c.stats.Hits++
+	} else {
+		c.stats.Miss++
+	}
+
+	return val, ttl, err
+}
+
 // Set allows to set a value for a given key identifier and also allows to specify
 // an expiration time
 func (c *Codec) Set(key interface{}, value interface{}, options *store.Options) error {

codec/interface.go

@@ -1,12 +1,15 @@
 package codec
 
 import (
+	"time"
+
 	"github.com/eko/gocache/store"
 )
 
 // CodecInterface represents an instance of a cache codec
 type CodecInterface interface {
 	Get(key interface{}) (interface{}, error)
+	GetWithTTL(key interface{}) (interface{}, time.Duration, error)
 	Set(key interface{}, value interface{}, options *store.Options) error
 	Delete(key interface{}) error
 	Invalidate(options store.InvalidateOptions) error

store/bigcache.go

@@ -53,7 +53,7 @@ func (s *BigcacheStore) Get(key interface{}) (interface{}, error) {
 	return item, err
 }
 
-// GetWithTTL returns data stored from a given key
+// GetWithTTL returns data stored from a given key and its corresponding TTL
 func (s *BigcacheStore) GetWithTTL(key interface{}) (interface{}, time.Duration, error) {
 	item, err := s.Get(key)
 	return item, 0, err

store/memcache.go

@@ -55,7 +55,7 @@ func (s *MemcacheStore) Get(key interface{}) (interface{}, error) {
 	return item.Value, err
 }
 
-// Get returns data stored from a given key
+// GetWithTTL returns data stored from a given key and its corresponding TTL
 func (s *MemcacheStore) GetWithTTL(key interface{}) (interface{}, time.Duration, error) {
 	item, err := s.client.Get(key.(string))
 	if err != nil {

store/redis.go

@@ -47,7 +47,7 @@ func (s *RedisStore) Get(key interface{}) (interface{}, error) {
 	return s.client.Get(key.(string)).Result()
 }
 
-// GetWithTTL returns data stored from a given key and the TTL associated
+// GetWithTTL returns data stored from a given key and its corresponding TTL
 func (s *RedisStore) GetWithTTL(key interface{}) (interface{}, time.Duration, error) {
 	object, err := s.client.Get(key.(string)).Result()
 	if err != nil {

store/ristretto.go

@@ -52,7 +52,7 @@ func (s *RistrettoStore) Get(key interface{}) (interface{}, error) {
 	return value, err
 }
 
-// GetWithTTL returns data stored from a given key
+// GetWithTTL returns data stored from a given key and its corresponding TTL
 func (s *RistrettoStore) GetWithTTL(key interface{}) (interface{}, time.Duration, error) {
 	value, err := s.Get(key)
 	return value, 0, err