Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Storage.FS.Handle

Description

This is meant to be used for the implementation of HasFS instances and not directly by client code.

Synopsis

data HandleOS osHandle = HandleOS {
- filePath :: FilePath
- handle :: MVar ( Maybe osHandle)
}
closeHandleOS :: HandleOS osHandle -> (osHandle -> IO ()) -> IO ()
isHandleClosedException :: IOException -> Bool
isOpenHandleOS :: HandleOS osHandle -> IO Bool
withOpenHandle :: String -> HandleOS osHandle -> (osHandle -> IO a) -> IO a

Documentation

data HandleOS osHandle Source #

File handlers for the IO instance for HasFS. This is parametric on the os.

The FilePath is used to improve error messages. The MVar is used to implement close . osHandle is Fd for unix and HANDLE for Windows.

Constructors

HandleOS
Fields filePath :: FilePath handle :: MVar ( Maybe osHandle)

Instances

Instances details

Eq ( HandleOS a) Source #
Instance details Defined in Ouroboros.Consensus.Storage.FS.Handle Methods (==) :: HandleOS a -> HandleOS a -> Bool Source # (/=) :: HandleOS a -> HandleOS a -> Bool Source #
Show ( HandleOS a) Source #
Instance details Defined in Ouroboros.Consensus.Storage.FS.Handle Methods showsPrec :: Int -> HandleOS a -> ShowS Source # show :: HandleOS a -> String Source # showList :: [ HandleOS a] -> ShowS Source #

closeHandleOS :: HandleOS osHandle -> (osHandle -> IO ()) -> IO () Source #

This is a no-op when the handle is already closed.

isHandleClosedException :: IOException -> Bool Source #

isOpenHandleOS :: HandleOS osHandle -> IO Bool Source #

withOpenHandle :: String -> HandleOS osHandle -> (osHandle -> IO a) -> IO a Source #

This is meant to be used for the implementation of individual file system commands. Using it for larger scopes woud not be correct, since we would not notice if the handle is closed.