Web.Simple.Cache

Provides a general caching interface along with a simple in-memory (process only) and file based cache implementations.

Cache Interface

class Cache c where

A class that captures a simple key-value caching interface. The keys are simply 'String'\'s and values are simply 'ByteString'\'s.

Methods

put :: MonadIO m => c -> String -> ByteString -> m ByteString

Store a value in the cache. The returned value should be the value that was just stored.

fetch :: MonadIO m => c -> String -> m (Maybe ByteString)

Retrieve a value from the cache.

invalidate :: MonadIO m => c -> String -> m ()

Invalidate a potentially existing value in the cache. Depending on the implementation this may or may not free the space used by the key-value pair.

Instances

Cache InMemCache

Cache FileSystemCache

fetchOr :: (Cache c, MonadIO m) => c -> String -> m ByteString -> m ByteString

Cache Implementations

data FileSystemCache

A file based cache implementation. Files are stored in subdirectories of fsCacheBase.

Instances

Cache FileSystemCache

newFileSystemCache :: FilePath -> FileSystemCache

Create a new FileSystemCache.

data InMemCache

An in-memory cache implementation. The current processes heap space is simply used as the cache.

Instances

Cache InMemCache

newInMemCache :: MonadIO m => m InMemCache

Create a new InMemCache.