Data.FileCache

Documentation

type FileCache = FileCacheR String

data FileCacheR r a

newFileCache :: Error r => IO (FileCacheR r a)

Generates a new file cache. The opaque type is for use with other functions.

killFileCache :: FileCacheR r a -> IO ()

Destroys the thread running the FileCache. Pretty dangerous stuff.

invalidate :: Error r => FilePath -> FileCacheR r a -> IO ()

Manually invalidates an entry.

query

Arguments

:: Error r

=> FileCacheR r a

-> FilePath

Path of the file entry

-> IO (Either r a)

The computation that will be used to populate the cache

-> IO (Either r a)

Queries the cache, populating it if necessary.

getCache :: Error r => FileCacheR r a -> IO (HashMap FilePath (Either r a, WatchDescriptor))

Gets a copy of the cache.

lazyQuery

Arguments

:: Error r

=> FileCacheR r a

-> FilePath

Path of the file entry

-> IO (Either r a)

The computation that will be used to populate the cache

-> IO (Either r a)

Just like query, but with the standard Either type.