-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | cached hashmaps
--   
--   An polysemy interface for cached hashmaps and an interpreter
--   implemented using <a>cache</a>
@package cache-polysemy
@version 0.1.2

module Polysemy.Cache
data Cache k v (m :: * -> *) a
[Insert] :: (Eq k, Hashable k) => k -> v -> Cache k v m ()
[Insert'] :: (Eq k, Hashable k) => Maybe TimeSpec -> k -> v -> Cache k v m ()
[Lookup] :: (Eq k, Hashable k) => k -> Cache k v m (Maybe v)
[Lookup'] :: (Eq k, Hashable k) => k -> Cache k v m (Maybe v)
[Keys] :: (Eq k, Hashable k) => Cache k v m [k]
[Delete] :: (Eq k, Hashable k) => k -> Cache k v m ()
[FilterWithKey] :: (Eq k, Hashable k) => (k -> v -> Bool) -> Cache k v m ()
[Purge] :: (Eq k, Hashable k) => Cache k v m ()
[PurgeExpired] :: (Eq k, Hashable k) => Cache k v m ()
[Size] :: (Eq k, Hashable k) => Cache k v m Int
[DefaultExipration] :: (Eq k, Hashable k) => Cache k v m (Maybe TimeSpec)
[SetDefaultExpiration] :: (Eq k, Hashable k) => Maybe TimeSpec -> Cache k v m ()

-- | Insert an item into the cache, using the default expiration value of
--   the cache.
insert :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => k -> v -> Sem r ()

-- | Insert an item in the cache, with an explicit expiration value.
insert' :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => Maybe TimeSpec -> k -> v -> Sem r ()

-- | Lookup an item with the given key, and delete it if it is expired.
--   
--   The function will only return a value if it is present in the cache
--   and if the item is not expired.
--   
--   The function will eagerly delete the item from the cache if it is
--   expired.
lookup :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => k -> Sem r (Maybe v)

-- | Lookup an item with the given key, but don't delete it if it is
--   expired.
--   
--   The function will only return a value if it is present in the cache
--   and if the item is not expired.
--   
--   The function will not delete the item from the cache.
lookup' :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => k -> Sem r (Maybe v)

-- | Return all keys present in the cache.
keys :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => Sem r [k]

-- | Delete an item from the cache. Won't do anything if the item is not
--   present.
delete :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => k -> Sem r ()

-- | Keeps elements that satify a predicate (used for cache invalidation).
--   Note that the predicate might be called for expired items.
filterWithKey :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => (k -> v -> Bool) -> Sem r ()

-- | Delete all elements (cache invalidation).
purge :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => Sem r ()

-- | Delete all items that are expired.
--   
--   This is one big atomic operation.
purgeExpired :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => Sem r ()

-- | Return the size of the cache, including expired items.
size :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => Sem r Int

-- | Get the default expiration value of newly added cache items.
defaultExipration :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => Sem r (Maybe TimeSpec)

-- | Change the default expiration value of newly added cache items.
setDefaultExpiration :: forall k v r. (Eq k, Hashable k, Member (Cache k v) r) => Maybe TimeSpec -> Sem r ()

-- | Run a <a>Cache</a> using <a>AtomicState</a>
runCacheAtomicState :: forall k v r a. Members '[Embed IO, AtomicState (Cache k v)] r => Sem (Cache k v : r) a -> Sem r a

-- | Alternative version of <a>runCacheAtomicState</a> that uses
--   <a>Final</a> instead of <a>Embed</a>
runCacheAtomicState' :: forall k v r a. Members '[Final IO, AtomicState (Cache k v)] r => Sem (Cache k v : r) a -> Sem r a

-- | Run a <a>Cache</a>, given a default expiration time.
runCache :: forall k v r a. Members '[Embed IO] r => Maybe TimeSpec -> Sem (Cache k v : (AtomicState (Cache k v) : r)) a -> Sem r a

-- | Alternative version of <a>runCache</a> that uses <a>Final</a> instead
--   of <a>Embed</a>
runCache' :: forall k v r a. Members '[Final IO] r => Maybe TimeSpec -> Sem (Cache k v : (AtomicState (Cache k v) : (Embed IO : r))) a -> Sem r a