Modulebase-4.22.0.0Haskell2010

GHC.IO.Encoding.Failure

Types for specifying how text encoding/decoding fails

Synopsis

data CodingFailureMode
value codingFailureModeSuffix
value isSurrogate
value recoverDecode
value recoverEncode
value recoverDecode#
value recoverEncode#

Packagebase-4.22.0.0
Exports7
LanguageHaskell2010
LicenceBSD-3-Clause
SourceFailure.hs

datadata CodingFailureMode

Source#

The CodingFailureMode is used to construct System.IO.TextEncodings, and specifies how they handle illegal sequences.

Constructors

ErrorOnCodingFailure
Throw an error when an illegal sequence is encountered
IgnoreCodingFailure
Attempt to ignore and recover if an illegal sequence is encountered
TransliterateCodingFailure
Replace with the closest visual match upon an illegal sequence
RoundtripFailure
Use the private-use escape mechanism to attempt to allow illegal sequences to be roundtripped.

Instances1Show

Show CodingFailureModeDefined in ghc-internal-9.1401.0 · GHC.Internal.IO.Encoding.Failure

valuecodingFailureModeSuffix :: CodingFailureMode -> String

valueisSurrogate :: Char -> Bool

Source#

Some characters are actually "surrogate" codepoints defined for use in UTF-16. We need to signal an invalid character if we detect them when encoding a sequence of Chars into Word8s because they won't give valid Unicode.

We may also need to signal an invalid character if we detect them when encoding a sequence of Chars into Word8s because the RoundtripFailure mode creates these to round-trip bytes through our internal UTF-16 encoding.

valuerecoverDecode

valuerecoverEncode

valuerecoverDecode#

:: CodingFailureMode
-> Buffer Word8
-> Buffer Char
-> State# RealWorld
-> (# State# RealWorld, Buffer Word8, Buffer Char #)

valuerecoverEncode#

:: CodingFailureMode
-> Buffer Char
-> Buffer Word8
-> State# RealWorld
-> (# State# RealWorld, Buffer Char, Buffer Word8 #)