From aaa777180948074f2d65a23aedc4f7fc7e3d4761 Mon Sep 17 00:00:00 2001 From: Jasper Van der Jeugt Date: Thu, 21 Jan 2010 09:19:14 +0100 Subject: Some more documentation. --- src/Text/Hakyll/Internal/Cache.hs | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'src/Text/Hakyll/Internal') diff --git a/src/Text/Hakyll/Internal/Cache.hs b/src/Text/Hakyll/Internal/Cache.hs index 9b9fab1..d28f849 100644 --- a/src/Text/Hakyll/Internal/Cache.hs +++ b/src/Text/Hakyll/Internal/Cache.hs @@ -8,12 +8,18 @@ import Text.Hakyll.Hakyll (Hakyll) import Text.Hakyll.File import Data.Binary +-- | We can store all datatypes instantiating @Binary@ to the cache. The cache +-- directory is specified by the @HakyllConfiguration@, usually @_cache@. storeInCache :: (Binary a) => a -> FilePath -> Hakyll () storeInCache value path = do cachePath <- toCache path makeDirectories cachePath liftIO $ encodeFile cachePath value +-- | Get a value from the cache. The filepath given should not be located in the +-- cache. This function performs a timestamp check on the filepath and the +-- filepath in the cache, and only returns the cached value when it is still +-- up-to-date. getFromCache :: (Binary a) => FilePath -> Hakyll (Maybe a) getFromCache path = do cachePath <- toCache path -- cgit v1.2.3