Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x8fef28d2026-11-02Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02

ModuleCabal-3.18.1.0Haskell2010

Distribution.Utils.IOData

Contents

IOData & IODataMode type

Synopsis

data IOData
data IODataMode
class KnownIODataMode
value withIOData
value null
value hPutContents

PackageCabal-3.18.1.0
Exports6
LanguageHaskell2010
LicenceBSD-3-Clause
SourceIOData.hs

IOData & IODataMode type

datadata IOData

Represents either textual or binary data passed via I/O functions which support binary/text mode

Constructors

IODataText String
How Text gets encoded is usually locale-dependent.
IODataBinary ByteString
Raw binary which gets read/written in binary mode.

Instances1NFData

NFData IODataDefined in Cabal-3.18.1.0 · Distribution.Utils.IOData

datadata IODataMode mode where

Phantom-typed GADT representation of the mode of IOData, containing no other data.

Constructors

IODataModeText :: IODataMode [Char]
IODataModeBinary :: IODataMode ByteString

classclass NFData mode => KnownIODataMode mode where

Methods

hGetIODataContents :: Handle -> IO mode
IOData Wrapper for hGetContents
Note: This operation uses lazy I/O. Use NFData to force all data to be read and consequently the internal file handle to be closed.
toIOData :: mode -> IOData
iodataMode :: IODataMode mode

Instances2KnownIODataMode

KnownIODataMode ByteStringDefined in Cabal-3.18.1.0 · Distribution.Utils.IOData
a ~ Char => KnownIODataMode [a]Defined in Cabal-3.18.1.0 · Distribution.Utils.IOData

valuewithIOData :: IOData -> (forall mode. IODataMode mode -> mode -> r) -> r

Applies a function polymorphic over IODataMode to an IOData value.

valuenull :: IOData -> Bool

Test whether IOData is empty

valuehPutContents :: Handle -> IOData -> IO ()

IOData Wrapper for hPutStr and hClose

This is the dual operation to hGetIODataContents, and consequently the handle is closed with hClose.

Note: this performs lazy-IO.