Copyright	(c) 2014-2021 Amy de Buitléir
License	BSD-style
Maintainer	amy@nualeargais.ie
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

ALife.Creatur.Database.CachedFileSystemInternal

Description

A module containing private CachedFileSystem internals. Most developers should use CachedFileSystem instead. This module is subject to change without notice.

Synopsis

data CachedFSDatabase r = CachedFSDatabase {
- database :: FSDatabase r
- cache :: [r]
- maxCacheSize :: Int
}
withFSDB :: Monad m => StateT (FSDatabase r) m a -> StateT (CachedFSDatabase r) m a
fromCache :: Record r => String -> StateT (CachedFSDatabase r) IO (Maybe r)
addToCache :: SizedRecord r => r -> StateT (CachedFSDatabase r) IO ()
deleteByKeyFromCache :: SizedRecord r => String -> StateT (CachedFSDatabase r) IO ()
deleteFromCache :: SizedRecord r => r -> StateT (CachedFSDatabase r) IO ()
trimCache :: SizedRecord r => StateT (CachedFSDatabase r) IO ()
trim :: SizedRecord r => Int -> [r] -> [r]
listSize :: SizedRecord r => [r] -> Int
mkCachedFSDatabase :: FilePath -> Int -> CachedFSDatabase r

Documentation

data CachedFSDatabase r Source #

A simple database where each record is stored in a separate file, and the name of the file is the record's key.

Constructors

CachedFSDatabase
Fields database :: FSDatabase r cache :: [r] maxCacheSize :: Int

Instances

Instances details

Eq r => Eq (CachedFSDatabase r) Source #
Instance details Defined in ALife.Creatur.Database.CachedFileSystemInternal Methods (==) :: CachedFSDatabase r -> CachedFSDatabase r -> Bool # (/=) :: CachedFSDatabase r -> CachedFSDatabase r -> Bool #
Show r => Show (CachedFSDatabase r) Source #
Instance details Defined in ALife.Creatur.Database.CachedFileSystemInternal Methods showsPrec :: Int -> CachedFSDatabase r -> ShowS # show :: CachedFSDatabase r -> String # showList :: [CachedFSDatabase r] -> ShowS #
SizedRecord r => Database (CachedFSDatabase r) Source #
Instance details Defined in ALife.Creatur.Database.CachedFileSystemInternal Associated Types type DBRecord (CachedFSDatabase r) Source # Methods keys :: StateT (CachedFSDatabase r) IO [String] Source # numRecords :: StateT (CachedFSDatabase r) IO Int Source # archivedKeys :: StateT (CachedFSDatabase r) IO [String] Source # lookup :: String -> StateT (CachedFSDatabase r) IO (Either String (DBRecord (CachedFSDatabase r))) Source # lookupInArchive :: String -> StateT (CachedFSDatabase r) IO (Either String (DBRecord (CachedFSDatabase r))) Source # readAll :: StateT (CachedFSDatabase r) IO [Either String (DBRecord (CachedFSDatabase r))] Source # readAllInArchive :: StateT (CachedFSDatabase r) IO [Either String (DBRecord (CachedFSDatabase r))] Source # store :: DBRecord (CachedFSDatabase r) -> StateT (CachedFSDatabase r) IO () Source # delete :: String -> StateT (CachedFSDatabase r) IO () Source #
type DBRecord (CachedFSDatabase r) Source #
Instance details Defined in ALife.Creatur.Database.CachedFileSystemInternal type DBRecord (CachedFSDatabase r) = r

withFSDB :: Monad m => StateT (FSDatabase r) m a -> StateT (CachedFSDatabase r) m a Source #

fromCache :: Record r => String -> StateT (CachedFSDatabase r) IO (Maybe r) Source #

addToCache :: SizedRecord r => r -> StateT (CachedFSDatabase r) IO () Source #

deleteByKeyFromCache :: SizedRecord r => String -> StateT (CachedFSDatabase r) IO () Source #

deleteFromCache :: SizedRecord r => r -> StateT (CachedFSDatabase r) IO () Source #

trimCache :: SizedRecord r => StateT (CachedFSDatabase r) IO () Source #

trim :: SizedRecord r => Int -> [r] -> [r] Source #

listSize :: SizedRecord r => [r] -> Int Source #

mkCachedFSDatabase :: FilePath -> Int -> CachedFSDatabase r Source #

mkFSDatabase d (re)creates the FSDatabase in the directory d.