| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
Effectful.FileSystem.HandleReader.Static
Description
Provides a static effect for reading a handle.
Since: 0.1
Synopsis
- data HandleReader (a :: Type -> Type) b
- hIsEOF :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool
- hGetBuffering :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es BufferMode
- hIsOpen :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool
- hIsClosed :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool
- hIsReadable :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool
- hIsWritable :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool
- hIsSeekable :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool
- hIsTerminalDevice :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool
- hGetEcho :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool
- hWaitForInput :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Bool
- hReady :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool
- hGetChar :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Char
- hGetLine :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es ByteString
- hGetContents :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es ByteString
- hGet :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es ByteString
- hGetSome :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es ByteString
- hGetNonBlocking :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es ByteString
- runHandleReader :: forall (es :: [Effect]) a. (HasCallStack, IOE :> es) => Eff (HandleReader ': es) a -> Eff es a
- hGetLineUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es (Either UnicodeException Text)
- hGetLineUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Text
- hGetLineUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Text
- hGetContentsUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es (Either UnicodeException Text)
- hGetContentsUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Text
- hGetContentsUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Text
- hGetUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es (Either UnicodeException Text)
- hGetUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text
- hGetUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text
- hGetSomeUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es (Either UnicodeException Text)
- hGetSomeUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text
- hGetSomeUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text
- hGetNonBlockingUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es (Either UnicodeException Text)
- hGetNonBlockingUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text
- hGetNonBlockingUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text
- data ByteString
- data Handle
- type OsPath = OsString
- data Text
- data UnicodeException
Effect
data HandleReader (a :: Type -> Type) b Source #
Static effect for reading a handle.
Since: 0.1
Instances
| type DispatchOf HandleReader Source # | |
Defined in Effectful.FileSystem.HandleReader.Static | |
| data StaticRep HandleReader Source # | |
Defined in Effectful.FileSystem.HandleReader.Static | |
hIsEOF :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool Source #
Lifted hIsEof.
Since: 0.1
hGetBuffering :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es BufferMode Source #
Lifted hGetBuffering.
Since: 0.1
hIsOpen :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool Source #
Lifted hIsOpen.
Since: 0.1
hIsClosed :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool Source #
Lifted hIsClosed.
Since: 0.1
hIsReadable :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool Source #
Lifted hIsReadable.
Since: 0.1
hIsWritable :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool Source #
Lifted hIsWritable.
Since: 0.1
hIsSeekable :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool Source #
Lifted hIsSeekable.
Since: 0.1
hIsTerminalDevice :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool Source #
Lifted hIsTerminalDevice.
Since: 0.1
hGetEcho :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool Source #
Lifted hGetEcho.
Since: 0.1
hWaitForInput :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Bool Source #
Lifted hWaitForInput.
Since: 0.1
hReady :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Bool Source #
Lifted hReady.
Since: 0.1
hGetChar :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Char Source #
Lifted hGetChar.
Since: 0.1
hGetLine :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es ByteString Source #
Lifted hGetLine.
Since: 0.1
hGetContents :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es ByteString Source #
Lifted hGetContents.
Since: 0.1
hGet :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es ByteString Source #
Lifted hGet.
Since: 0.1
hGetSome :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es ByteString Source #
Lifted hGetSome.
Since: 0.1
hGetNonBlocking :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es ByteString Source #
Lifted hGetNonBlocking.
Since: 0.1
Handlers
runHandleReader :: forall (es :: [Effect]) a. (HasCallStack, IOE :> es) => Eff (HandleReader ': es) a -> Eff es a Source #
Runs HandleReader in IO.
Since: 0.1
UTF-8 Utils
GetLine
hGetLineUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es (Either UnicodeException Text) Source #
hGetLine and decodeUtf8.
Since: 0.1
hGetLineUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Text Source #
hGetLine and decodeUtf8Lenient.
Since: 0.1
hGetLineUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Text Source #
hGetLine and decodeUtf8ThrowM.
Since: 0.1
GetContents
hGetContentsUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es (Either UnicodeException Text) Source #
hGetContents and decodeUtf8.
Since: 0.1
hGetContentsUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Text Source #
hGetContents and decodeUtf8Lenient.
Since: 0.1
hGetContentsUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Eff es Text Source #
hGetContents and decodeUtf8ThrowM.
Since: 0.1
Get
hGetUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es (Either UnicodeException Text) Source #
hGet and decodeUtf8.
Since: 0.1
hGetUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text Source #
hGet and decodeUtf8Lenient.
Since: 0.1
hGetUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text Source #
hGet and decodeUtf8ThrowM.
Since: 0.1
GetSome
hGetSomeUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es (Either UnicodeException Text) Source #
hGetSome and decodeUtf8.
Since: 0.1
hGetSomeUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text Source #
hGetSome and decodeUtf8Lenient.
Since: 0.1
hGetSomeUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text Source #
hGetSome and decodeUtf8ThrowM.
Since: 0.1
GetNonBlocking
hGetNonBlockingUtf8 :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es (Either UnicodeException Text) Source #
hGetNonBlocking and decodeUtf8.
Since: 0.1
hGetNonBlockingUtf8Lenient :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text Source #
hGetNonBlocking and decodeUtf8Lenient.
Since: 0.1
hGetNonBlockingUtf8ThrowM :: forall (es :: [Effect]). (HandleReader :> es, HasCallStack) => Handle -> Int -> Eff es Text Source #
hGetNonBlocking and decodeUtf8ThrowM.
Since: 0.1
Re-exports
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.
Type representing filenames/pathnames.
This type doesn't add any guarantees over OsString.
A space efficient, packed, unboxed Unicode text type.
data UnicodeException #
An exception type for representing Unicode encoding errors.
Instances
| NFData UnicodeException # | |
Defined in Data.Text.Encoding.Error Methods rnf :: UnicodeException -> () # | |
| Exception UnicodeException # | |
Defined in Data.Text.Encoding.Error Methods toException :: UnicodeException -> SomeException # fromException :: SomeException -> Maybe UnicodeException # | |
| Show UnicodeException # | |
Defined in Data.Text.Encoding.Error Methods showsPrec :: Int -> UnicodeException -> ShowS # show :: UnicodeException -> String # showList :: [UnicodeException] -> ShowS # | |
| Eq UnicodeException # | |
Defined in Data.Text.Encoding.Error Methods (==) :: UnicodeException -> UnicodeException -> Bool # (/=) :: UnicodeException -> UnicodeException -> Bool # | |