| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Effectful.FileSystem.IO
Description
Lifted System.IO.
Synopsis
- data FileSystem :: Effect
- runFileSystem :: (HasCallStack, IOE :> es) => Eff (FileSystem : es) a -> Eff es a
- data IOMode
- data Handle
- stdin :: Handle
- stdout :: Handle
- stderr :: Handle
- withFile :: FileSystem :> es => FilePath -> IOMode -> (Handle -> Eff es a) -> Eff es a
- withBinaryFile :: FileSystem :> es => FilePath -> IOMode -> (Handle -> Eff es a) -> Eff es a
- openFile :: FileSystem :> es => FilePath -> IOMode -> Eff es Handle
- hClose :: FileSystem :> es => Handle -> Eff es ()
- hFlush :: FileSystem :> es => Handle -> Eff es ()
- hFileSize :: FileSystem :> es => Handle -> Eff es Integer
- hSetFileSize :: FileSystem :> es => Handle -> Integer -> Eff es ()
- hIsEOF :: FileSystem :> es => Handle -> Eff es Bool
- data BufferMode
- hSetBuffering :: FileSystem :> es => Handle -> BufferMode -> Eff es ()
- hGetBuffering :: FileSystem :> es => Handle -> Eff es BufferMode
- hSeek :: FileSystem :> es => Handle -> SeekMode -> Integer -> Eff es ()
- data SeekMode
- hTell :: FileSystem :> es => Handle -> Eff es Integer
- hIsOpen :: FileSystem :> es => Handle -> Eff es Bool
- hIsClosed :: FileSystem :> es => Handle -> Eff es Bool
- hIsReadable :: FileSystem :> es => Handle -> Eff es Bool
- hIsWritable :: FileSystem :> es => Handle -> Eff es Bool
- hIsSeekable :: FileSystem :> es => Handle -> Eff es Bool
- hIsTerminalDevice :: FileSystem :> es => Handle -> Eff es Bool
- hSetEcho :: FileSystem :> es => Handle -> Bool -> Eff es ()
- hGetEcho :: FileSystem :> es => Handle -> Eff es Bool
- hWaitForInput :: FileSystem :> es => Handle -> Int -> Eff es Bool
- hReady :: FileSystem :> es => Handle -> Eff es Bool
Effect
data FileSystem :: Effect Source #
An effect for interacting with the filesystem.
Instances
| type DispatchOf FileSystem Source # | |
Defined in Effectful.FileSystem.Effect | |
| data StaticRep FileSystem Source # | |
Defined in Effectful.FileSystem.Effect | |
Handlers
runFileSystem :: (HasCallStack, IOE :> es) => Eff (FileSystem : es) a -> Eff es a Source #
Run the FileSystem effect.
IO
See openFile
Constructors
| ReadMode | |
| WriteMode | |
| AppendMode | |
| ReadWriteMode |
Haskell defines operations to read and write characters from and to files,
represented by values of type Handle. Each value of this type is a
handle: a record used by the Haskell run-time system to manage I/O
with file system objects. A handle has at least the following properties:
- whether it manages input or output or both;
- whether it is open, closed or semi-closed;
- whether the object is seekable;
- whether buffering is disabled, or enabled on a line or block basis;
- a buffer (whose length may be zero).
Most handles will also have a current I/O position indicating where the next
input or output operation will occur. A handle is readable if it
manages only input or both input and output; likewise, it is writable if
it manages only output or both input and output. A handle is open when
first allocated.
Once it is closed it can no longer be used for either input or output,
though an implementation cannot re-use its storage while references
remain to it. Handles are in the Show and Eq classes. The string
produced by showing a handle is system dependent; it should include
enough information to identify the handle for debugging. A handle is
equal according to == only to itself; no attempt
is made to compare the internal state of different handles for equality.
Instances
withFile :: FileSystem :> es => FilePath -> IOMode -> (Handle -> Eff es a) -> Eff es a Source #
Lifted withFile.
withBinaryFile :: FileSystem :> es => FilePath -> IOMode -> (Handle -> Eff es a) -> Eff es a Source #
Lifted withBinaryFile.
hSetFileSize :: FileSystem :> es => Handle -> Integer -> Eff es () Source #
Lifted hSetFileSize
data BufferMode #
Three kinds of buffering are supported: line-buffering, block-buffering or no-buffering. These modes have the following effects. For output, items are written out, or flushed, from the internal buffer according to the buffer mode:
- line-buffering: the entire output buffer is flushed
whenever a newline is output, the buffer overflows,
a
hFlushis issued, or the handle is closed. - block-buffering: the entire buffer is written out whenever it
overflows, a
hFlushis issued, or the handle is closed. - no-buffering: output is written immediately, and never stored in the buffer.
An implementation is free to flush the buffer more frequently, but not less frequently, than specified above. The output buffer is emptied as soon as it has been written out.
Similarly, input occurs according to the buffer mode for the handle:
- line-buffering: when the buffer for the handle is not empty, the next item is obtained from the buffer; otherwise, when the buffer is empty, characters up to and including the next newline character are read into the buffer. No characters are available until the newline character is available or the buffer is full.
- block-buffering: when the buffer for the handle becomes empty, the next block of data is read into the buffer.
- no-buffering: the next input item is read and returned.
The
hLookAheadoperation implies that even a no-buffered handle may require a one-character buffer.
The default buffering mode when a handle is opened is implementation-dependent and may depend on the file system object which is attached to that handle. For most implementations, physical files will normally be block-buffered and terminals will normally be line-buffered.
Constructors
| NoBuffering | buffering is disabled if possible. |
| LineBuffering | line-buffering should be enabled if possible. |
| BlockBuffering (Maybe Int) | block-buffering should be enabled if possible.
The size of the buffer is |
Instances
| Read BufferMode | Since: base-4.2.0.0 |
Defined in GHC.IO.Handle.Types Methods readsPrec :: Int -> ReadS BufferMode # readList :: ReadS [BufferMode] # readPrec :: ReadPrec BufferMode # readListPrec :: ReadPrec [BufferMode] # | |
| Show BufferMode | Since: base-4.2.0.0 |
Defined in GHC.IO.Handle.Types Methods showsPrec :: Int -> BufferMode -> ShowS # show :: BufferMode -> String # showList :: [BufferMode] -> ShowS # | |
| Eq BufferMode | Since: base-4.2.0.0 |
Defined in GHC.IO.Handle.Types | |
| Ord BufferMode | Since: base-4.2.0.0 |
Defined in GHC.IO.Handle.Types Methods compare :: BufferMode -> BufferMode -> Ordering # (<) :: BufferMode -> BufferMode -> Bool # (<=) :: BufferMode -> BufferMode -> Bool # (>) :: BufferMode -> BufferMode -> Bool # (>=) :: BufferMode -> BufferMode -> Bool # max :: BufferMode -> BufferMode -> BufferMode # min :: BufferMode -> BufferMode -> BufferMode # | |
hSetBuffering :: FileSystem :> es => Handle -> BufferMode -> Eff es () Source #
Lifted hSetBuffering
hGetBuffering :: FileSystem :> es => Handle -> Eff es BufferMode Source #
Lifted hGetBuffering
A mode that determines the effect of hSeek hdl mode i.
Constructors
| AbsoluteSeek | the position of |
| RelativeSeek | the position of |
| SeekFromEnd | the position of |
Instances
| Enum SeekMode | Since: base-4.2.0.0 |
| Ix SeekMode | Since: base-4.2.0.0 |
Defined in GHC.IO.Device Methods range :: (SeekMode, SeekMode) -> [SeekMode] # index :: (SeekMode, SeekMode) -> SeekMode -> Int # unsafeIndex :: (SeekMode, SeekMode) -> SeekMode -> Int # inRange :: (SeekMode, SeekMode) -> SeekMode -> Bool # rangeSize :: (SeekMode, SeekMode) -> Int # unsafeRangeSize :: (SeekMode, SeekMode) -> Int # | |
| Read SeekMode | Since: base-4.2.0.0 |
| Show SeekMode | Since: base-4.2.0.0 |
| Eq SeekMode | Since: base-4.2.0.0 |
| Ord SeekMode | Since: base-4.2.0.0 |
Defined in GHC.IO.Device | |
hIsReadable :: FileSystem :> es => Handle -> Eff es Bool Source #
Lifted hIsReadable
hIsWritable :: FileSystem :> es => Handle -> Eff es Bool Source #
Lifted hIsWritable
hIsSeekable :: FileSystem :> es => Handle -> Eff es Bool Source #
Lifted hIsSeekable
hIsTerminalDevice :: FileSystem :> es => Handle -> Eff es Bool Source #
Lifted hIsTerminalDevice
hWaitForInput :: FileSystem :> es => Handle -> Int -> Eff es Bool Source #
Lifted hWaitForInput