Moduletext-2.1.4Haskell2010

Data.Text.Internal.Fusion

Warning: this is an internal module, and does not have a stable API or name. Functions in this module may not check or enforce preconditions expected by public modules. Use at your own risk!

Text manipulation functions represented as fusible operations over streams.

Contents

Types
Creation and elimination
Transformations
Construction
Scans
Accumulating maps
Generation and unfolding
Indexing

Synopsis

data Stream
data Step
value stream
value streamLn
value unstream
value reverseStream
value length
value reverse
value reverseScanr
value mapAccumL
value unfoldrN
value index
value findIndex
value countChar

Packagetext-2.1.4
Exports14
LanguageHaskell2010
LicenceBSD-2-Clause
SourceFusion.hs

Types

datadata Stream a

Source#

A co-recursive type yielding a single element at a time depending on the internal state it carries.

Constructors

forall s. Stream (s -> Step s a) !s !Size

Instances2Eq, Ord

Eq a => Eq (Stream a)Defined in text-2.1.4 · Data.Text.Internal.Fusion.Types
Ord a => Ord (Stream a)Defined in text-2.1.4 · Data.Text.Internal.Fusion.Types

datadata Step s a

Source#

Intermediate result in a processing pipeline.

Constructors

Done
Skip !s
Yield !a !s

Creation and elimination

valuestream :: Text -> Stream Char

Source#

O(n) Convert Text into a Stream Char.

Properties

unstream . stream = id

stream . unstream = id

valuestreamLn :: Text -> Stream Char

Source#

O(n) streamLn t = stream (t <> '\n')

valueunstream :: Stream Char -> Text

Source#

O(n) Convert Stream Char into a Text.

Properties

unstream . stream = id

stream . unstream = id

valuereverseStream :: Text -> Stream Char

Source#

O(n) Converts Text into a Stream Char, but iterates backwards through the text.

Properties

unstream . reverseStream = reverse

valuelength :: Stream Char -> Int

Source#

O(n) Returns the number of characters in a Stream.

Properties

length . stream = length

Transformations

valuereverse :: Stream Char -> Text

Source#

O(n) Reverse the characters of a Stream returning Text.

Properties

reverse . stream = reverse

Construction

Scans

valuereverseScanr :: (Char -> Char -> Char) -> Char -> Stream Char -> Stream Char

Source#

O(n) Perform the equivalent of scanr over a list, only with the input and result reversed.

Properties

reverse . reverseScanr f c . reverseStream = scanr f c

Accumulating maps

valuemapAccumL :: (a -> Char -> (a, Char)) -> a -> Stream Char -> (a, Text)

Source#

O(n) Like a combination of map and foldl'. Applies a function to each element of a Text, passing an accumulating parameter from left to right, and returns a final Text.

Properties

mapAccumL g z0 . stream = mapAccumL g z0

Generation and unfolding

valueunfoldrN :: Int -> (a -> Maybe (Char, a)) -> a -> Stream Char

Source#

O(n) Like unfoldr, unfoldrN builds a stream from a seed value. However, the length of the result is limited by the first argument to unfoldrN. This function is more efficient than unfoldr when the length of the result is known.

Properties

unstream (unfoldrN n f a) = unfoldrN n f a

Indexing

valueindex :: HasCallStack => Stream Char -> Int -> Char

Source#

O(n) stream index (subscript) operator, starting from 0.

Properties

index (stream t) n  = index t n

valuefindIndex :: (Char -> Bool) -> Stream Char -> Maybe Int

Source#

The findIndex function takes a predicate and a stream and returns the index of the first element in the stream satisfying the predicate.

Properties

findIndex p . stream  = findIndex p

valuecountChar :: Char -> Stream Char -> Int

Source#

O(n) The count function returns the number of times the query element appears in the given stream.

Properties

countChar c . stream  = countChar c