Safe Haskell | None |
---|---|
Language | GHC2021 |
Effectful.FileSystem.HandleWriter.Dynamic
Description
Provides a dynamic effect for writing to a handle.
Since: 0.1
Synopsis
- data HandleWriter (a :: Type -> Type) b where
- OpenBinaryFile :: forall (a :: Type -> Type). OsPath -> IOMode -> HandleWriter a Handle
- WithBinaryFile :: forall (a :: Type -> Type) b. OsPath -> IOMode -> (Handle -> a b) -> HandleWriter a b
- HClose :: forall (a :: Type -> Type). Handle -> HandleWriter a ()
- HFlush :: forall (a :: Type -> Type). Handle -> HandleWriter a ()
- HSetFileSize :: forall (a :: Type -> Type). Handle -> Integer -> HandleWriter a ()
- HSetBuffering :: forall (a :: Type -> Type). Handle -> BufferMode -> HandleWriter a ()
- HSeek :: forall (a :: Type -> Type). Handle -> SeekMode -> Integer -> HandleWriter a ()
- HTell :: forall (a :: Type -> Type). Handle -> HandleWriter a Integer
- HSetEcho :: forall (a :: Type -> Type). Handle -> Bool -> HandleWriter a ()
- HPut :: forall (a :: Type -> Type). Handle -> ByteString -> HandleWriter a ()
- HPutNonBlocking :: forall (a :: Type -> Type). Handle -> ByteString -> HandleWriter a ByteString
- openBinaryFile :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => OsPath -> IOMode -> Eff es Handle
- withBinaryFile :: forall (es :: [Effect]) a. (HandleWriter :> es, HasCallStack) => OsPath -> IOMode -> (Handle -> Eff es a) -> Eff es a
- hClose :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Eff es ()
- hFlush :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Eff es ()
- hSetFileSize :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Integer -> Eff es ()
- hSetBuffering :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> BufferMode -> Eff es ()
- hSeek :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> SeekMode -> Integer -> Eff es ()
- hTell :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Eff es Integer
- hSetEcho :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Bool -> Eff es ()
- hPut :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> ByteString -> Eff es ()
- hPutNonBlocking :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> ByteString -> Eff es ByteString
- runHandleWriter :: forall (es :: [Effect]) a. (HasCallStack, IOE :> es) => Eff (HandleWriter ': es) a -> Eff es a
- hPutUtf8 :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Text -> Eff es ()
- hPutNonBlockingUtf8 :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Text -> Eff es ByteString
- die :: forall (es :: [Effect]) a. (HandleWriter :> es, HasCallStack) => String -> Eff es a
- data BufferMode
- data ByteString
- data Handle
- data IOMode
- type OsPath = OsString
- data SeekMode
- data Text
Effect
data HandleWriter (a :: Type -> Type) b where Source #
Dynamic effect for writing to a handle.
Since: 0.1
Constructors
OpenBinaryFile :: forall (a :: Type -> Type). OsPath -> IOMode -> HandleWriter a Handle | |
WithBinaryFile :: forall (a :: Type -> Type) b. OsPath -> IOMode -> (Handle -> a b) -> HandleWriter a b | |
HClose :: forall (a :: Type -> Type). Handle -> HandleWriter a () | |
HFlush :: forall (a :: Type -> Type). Handle -> HandleWriter a () | |
HSetFileSize :: forall (a :: Type -> Type). Handle -> Integer -> HandleWriter a () | |
HSetBuffering :: forall (a :: Type -> Type). Handle -> BufferMode -> HandleWriter a () | |
HSeek :: forall (a :: Type -> Type). Handle -> SeekMode -> Integer -> HandleWriter a () | |
HTell :: forall (a :: Type -> Type). Handle -> HandleWriter a Integer | |
HSetEcho :: forall (a :: Type -> Type). Handle -> Bool -> HandleWriter a () | |
HPut :: forall (a :: Type -> Type). Handle -> ByteString -> HandleWriter a () | |
HPutNonBlocking :: forall (a :: Type -> Type). Handle -> ByteString -> HandleWriter a ByteString |
Instances
ShowEffect HandleWriter Source # | Since: 0.1 |
Defined in Effectful.FileSystem.HandleWriter.Dynamic Methods showEffectCons :: forall (m :: Type -> Type) a. HandleWriter m a -> String Source # | |
type DispatchOf HandleWriter Source # | Since: 0.1 |
Defined in Effectful.FileSystem.HandleWriter.Dynamic |
openBinaryFile :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => OsPath -> IOMode -> Eff es Handle Source #
Lifted openBinaryFile
.
Since: 0.1
withBinaryFile :: forall (es :: [Effect]) a. (HandleWriter :> es, HasCallStack) => OsPath -> IOMode -> (Handle -> Eff es a) -> Eff es a Source #
Lifted withBinaryFile
.
Since: 0.1
hClose :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Eff es () Source #
Lifted hClose
.
Since: 0.1
hFlush :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Eff es () Source #
Lifted hFlush
.
Since: 0.1
hSetFileSize :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Integer -> Eff es () Source #
Lifted hSetFileSize
.
Since: 0.1
hSetBuffering :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> BufferMode -> Eff es () Source #
Lifted hSetBuffering
.
Since: 0.1
hSeek :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> SeekMode -> Integer -> Eff es () Source #
Lifted hSeek
.
Since: 0.1
hTell :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Eff es Integer Source #
Lifted hTell
.
Since: 0.1
hSetEcho :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Bool -> Eff es () Source #
Lifted hSetEcho
.
Since: 0.1
hPut :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> ByteString -> Eff es () Source #
Lifted hPut
.
Since: 0.1
hPutNonBlocking :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> ByteString -> Eff es ByteString Source #
Lifted hPutNonBlocking
.
Since: 0.1
Handlers
runHandleWriter :: forall (es :: [Effect]) a. (HasCallStack, IOE :> es) => Eff (HandleWriter ': es) a -> Eff es a Source #
Runs HandleWriter
in IO
.
Since: 0.1
UTF-8 Utils
hPutUtf8 :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Text -> Eff es () Source #
hPut
and encodeUtf8
.
Since: 0.1
hPutNonBlockingUtf8 :: forall (es :: [Effect]). (HandleWriter :> es, HasCallStack) => Handle -> Text -> Eff es ByteString Source #
hPutNonBlocking
and encodeUtf8
.
Since: 0.1
Misc
die :: forall (es :: [Effect]) a. (HandleWriter :> es, HasCallStack) => String -> Eff es a Source #
Write given error message to stderr
and terminate with exitFailure
.
Since: 0.1
Re-exports
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
hFlush
is issued, or the handle is closed. - block-buffering: the entire buffer is written out whenever it
overflows, a
hFlush
is 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
hLookAhead
operation 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.Internal.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.Internal.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.Internal.IO.Handle.Types | |
Ord BufferMode | @since base-4.2.0.0 |
Defined in GHC.Internal.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 # |
data ByteString #
A space-efficient representation of a Word8
vector, supporting many
efficient operations.
A ByteString
contains 8-bit bytes, or by using the operations from
Data.ByteString.Char8 it can be interpreted as containing 8-bit
characters.
Instances
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.
See openFile
Constructors
ReadMode | |
WriteMode | |
AppendMode | |
ReadWriteMode |
Type representing filenames/pathnames.
This type doesn't add any guarantees over OsString
.
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 |
Defined in GHC.Internal.IO.Device | |
Ix SeekMode | @since base-4.2.0.0 |
Defined in GHC.Internal.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.Internal.IO.Device |