halfs-0.2: Haskell File System Source code Contents Index

Halfs.FSState

Description

Convenience module for exporting usually useful stuff ALL unsafe* functions must be deleted and turned into primitives in this module.

Synopsis

data StateHandle = StateHandle { stateFineMVar :: MVar FSRoot stateCoarseMVar :: Maybe (MVar ()) } data FSWrite a unsafeLiftIOWrite :: IO a -> FSWrite a runFSWrite :: FSWrite a -> FSState a evalFSWriteIO :: FSWrite a -> FSRoot -> IO a evalFSWriteIOMV :: FSWrite a -> StateHandle -> IO a runFSWriteIO :: FSWrite a -> FSRoot -> IO (a, FSRoot) readToWrite :: FSRead a -> FSWrite a readToWriteCont :: ((forall s. m s -> FSRead a) -> FSRead a) -> (forall s. m s -> FSWrite a) -> FSWrite a writeToBuffer :: Binary a => BinHandle -> a -> FSWrite () unsafeLiftIOWriteWithRoot :: (FSRoot -> IO a) -> FSWrite a unsafeWriteGet :: FSWrite FSRoot putStrLnWriteRead :: String -> FSWrite () updateInodeCacheWrite :: Inode -> FSWrite () modifyFSWrite :: (FSRoot -> FSWrite (FSRoot, a)) -> FSWrite a data FSRead a unsafeLiftIORead :: IO a -> FSRead a runFSRead :: FSRead a -> FSState a runFSReadIO :: FSRead a -> FSRoot -> (IOError -> IO (a, FSRoot)) -> IO (a, FSRoot) evalFSReadIOMV :: FSRead a -> StateHandle -> IO a unsafeReadGet :: FSRead FSRoot unsafeModifyFSRead :: (FSRoot -> (FSRoot, a)) -> FSRead a unsafeWriteToRead :: FSWrite a -> FSRead a newReadRef :: a -> FSRead (ReadRef a) readReadRef :: ReadRef a -> FSRead a modifyReadRef :: ReadRef a -> (a -> a) -> FSRead () writeReadRef :: ReadRef a -> a -> FSRead () takeMVarRW :: FSRW m => MVar a -> m a readMVarRW :: FSRW m => MVar a -> m a putMVarRW :: FSRW m => MVar a -> a -> m () modifyMVarRW_ :: FSRW m => MVar a -> (a -> IO a) -> m () modifyMVarRW_' :: (FSRW m, MonadError IOError m) => MVar a -> (a -> m a) -> m () module Control.Monad.Trans module Control.Monad.Error module Control.Monad.State class Monad m => FSRW m where unsafeLiftIORW :: IO a -> m a put get alreadyExistsEx :: FilePath -> IOError doesNotExistEx :: FilePath -> IOError eofEx :: FilePath -> IOError illegalOpEx :: FilePath -> IOError decLinksForInode :: Inode -> FSWrite () forkWithMVar :: (StateHandle -> FSWrite ()) -> FSWrite ThreadId forkFSWrite :: FSWrite () -> FSWrite ThreadId

Documentation

data StateHandle Source

Read-write state Constructors StateHandle stateFineMVar :: MVar FSRoot stateCoarseMVar :: Maybe (MVar ()) Instances Eq StateHandle

data FSWrite a Source

Instances Monad FSWrite FSRW FSWrite MonadError IOError FSWrite MonadState FSRoot FSWrite

unsafeLiftIOWrite :: IO a -> FSWrite a Source

FIX: Delete this function; it's temporary during refactoring. It violates safety requirements.

runFSWrite :: FSWrite a -> FSState a Source

Make this write-only monad into a read-write monad.

evalFSWriteIO :: FSWrite a -> FSRoot -> IO a Source

evalFSWriteIOMV :: FSWrite a -> StateHandle -> IO a Source

runFSWriteIO :: FSWrite a -> FSRoot -> IO (a, FSRoot) Source

readToWrite :: FSRead a -> FSWrite a Source

Safe since writers can be readers.

readToWriteCont :: ((forall s. m s -> FSRead a) -> FSRead a) -> (forall s. m s -> FSWrite a) -> FSWrite a Source

Safe since writers can be readers.

writeToBuffer :: Binary a => BinHandle -> a -> FSWrite () Source

unsafeLiftIOWriteWithRoot :: (FSRoot -> IO a) -> FSWrite a Source

unsafeWriteGet :: FSWrite FSRoot Source

Unsafe since it uses readMVar. For get-only situations, for reading and not writing; no mvar block.

putStrLnWriteRead :: String -> FSWrite () Source

updateInodeCacheWrite :: Inode -> FSWrite () Source

modifyFSWrite :: (FSRoot -> FSWrite (FSRoot, a)) -> FSWrite a Source

FIX: This f should probably be in the FSRW monad, since that doesn't have state.

data FSRead a Source

Instances Monad FSRead FSRW FSRead MonadError IOError FSRead

unsafeLiftIORead :: IO a -> FSRead a Source

FIX: Delete this function; it's temporary during refactoring. It violates safety requirements.

runFSRead :: FSRead a -> FSState a Source

Make this read-only monad into a read-write monad.

runFSReadIO :: FSRead a -> FSRoot -> (IOError -> IO (a, FSRoot)) -> IO (a, FSRoot) Source

evalFSReadIOMV :: FSRead a -> StateHandle -> IO a Source

unsafeReadGet :: FSRead FSRoot Source

Unsafe because it uses readMVar.

unsafeModifyFSRead :: (FSRoot -> (FSRoot, a)) -> FSRead a Source

FIX: Unsafe?

unsafeWriteToRead :: FSWrite a -> FSRead a Source

unsafe since this allows a reader to write.

newReadRef :: a -> FSRead (ReadRef a) Source

readReadRef :: ReadRef a -> FSRead a Source

modifyReadRef :: ReadRef a -> (a -> a) -> FSRead () Source

writeReadRef :: ReadRef a -> a -> FSRead () Source

takeMVarRW :: FSRW m => MVar a -> m a Source

readMVarRW :: FSRW m => MVar a -> m a Source

putMVarRW :: FSRW m => MVar a -> a -> m () Source

modifyMVarRW_ :: FSRW m => MVar a -> (a -> IO a) -> m () Source

modifyMVarRW_' :: (FSRW m, MonadError IOError m) => MVar a -> (a -> m a) -> m () Source

module Control.Monad.Trans

module Control.Monad.Error

module Control.Monad.State

class Monad m => FSRW m where Source

Methods unsafeLiftIORW :: IO a -> m a Source Instances FSRW IO FSRW FSWrite FSRW FSRead

put

get

alreadyExistsEx :: FilePath -> IOError Source

doesNotExistEx :: FilePath -> IOError Source

eofEx :: FilePath -> IOError Source

illegalOpEx :: FilePath -> IOError Source

decLinksForInode :: Inode -> FSWrite () Source

forkWithMVar :: (StateHandle -> FSWrite ()) -> FSWrite ThreadId Source

forkFSWrite :: FSWrite () -> FSWrite ThreadId Source

Produced by Haddock version 2.4.2