Moduleconduit-extra-1.3.8Haskell2010

Data.Conduit.Text

NOTE It is recommended to start using Data.Conduit.Combinators instead of this module.

Handle streams of text.

Parts of this code were taken from enumerator and adapted for conduits.

For many purposes, it's recommended to use the conduit-combinators library, which provides a more complete set of functions.

2 types
21 values

Packageconduit-extra-1.3.8
Exports23
LanguageHaskell2010
LicenceMIT
SourceText.hs

Text codecs

23 declarations

datadata Codec

A specific character encoding.

Since 0.3.0

Instances1Show

Show CodecDefined in conduit-extra-1.3.8 · Data.Conduit.Text

valueencode :: MonadThrow m => Codec -> ConduitT Text ByteString m ()

Convert text into bytes, using the provided codec. If the codec is not capable of representing an input character, an exception will be thrown.

Since 0.3.0

valuedecode :: MonadThrow m => Codec -> ConduitT ByteString Text m ()

Convert bytes into text, using the provided codec. If the codec is not capable of decoding an input byte sequence, an exception will be thrown.

Since 0.3.0

valueutf8 :: Codec

Since 0.3.0

valueutf16_le :: Codec

Since 0.3.0

valueutf16_be :: Codec

Since 0.3.0

valueutf32_le :: Codec

Since 0.3.0

valueutf32_be :: Codec

Since 0.3.0

valueascii :: Codec

Since 0.3.0

valueiso8859_1 :: Codec

Since 0.3.0

valuelines :: Monad m => ConduitT Text Text m ()

Emit each line separately

Since 0.4.1

valuelinesBounded :: MonadThrow m => Int -> ConduitT Text Text m ()

Variant of the lines function with an integer parameter. The text length of any emitted line never exceeds the value of the parameter. Whenever this is about to happen a LengthExceeded exception is thrown. This function should be used instead of the lines function whenever we are dealing with user input (e.g. a file upload) because we can't be sure that user input won't have extraordinarily large lines which would require large amounts of memory if consumed.

datadata TextException

Since 0.3.0

Constructors

DecodeException Codec Word8
EncodeException Codec Char
LengthExceeded Int
TextException SomeException
NewDecodeException !Text !Int !ByteString

Instances2Show, Exception

Show TextExceptionDefined in conduit-extra-1.3.8 · Data.Conduit.Text
Exception TextExceptionDefined in conduit-extra-1.3.8 · Data.Conduit.Text

valuetakeWhile :: Monad m => (Char -> Bool) -> ConduitT Text Text m ()

Since 1.0.8

valuedropWhile :: Monad m => (Char -> Bool) -> ConduitT Text o m ()

Since 1.0.8

valuetake :: Monad m => Int -> ConduitT Text Text m ()

Since 1.0.8

valuedrop :: Monad m => Int -> ConduitT Text o m ()

Since 1.0.8

valuefoldLines

:: Monad m
=> a -> ConduitM Text o m a
-> a
-> ConduitT Text o m a

Since 1.0.8

valuewithLine :: Monad m => ConduitT Text Void m a -> ConduitT Text o m (Maybe a)

Since 1.0.8

valuedecodeUtf8 :: MonadThrow m => ConduitT ByteString Text m ()

Decode a stream of binary data as UTF8.

valuedecodeUtf8Lenient :: Monad m => ConduitT ByteString Text m ()

Decode a stream of binary data as UTF8, replacing any invalid bytes with the Unicode replacement character.

valueencodeUtf8 :: (Monad m, Utf8 text binary) => ConduitT text binary m ()

Encode a stream of text as UTF8.

Subject to fusion

valuedetectUtf :: MonadThrow m => ConduitT ByteString Text m ()

Automatically determine which UTF variant is being used. This function checks for BOMs, removing them as necessary. It defaults to assuming UTF-8.

Since 1.1.9