Data.Text.Internal.Lazy.Fusion

text-1.2.1.3: An efficient packed Unicode text type.

Copyright | (c) 2009, 2010 Bryan O'Sullivan
License | BSD-style
Maintainer | bos@serpentine.com
Stability | experimental
Portability | GHC
Safe Haskell | None
Language | Haskell98

Data.Text.Internal.Lazy.Fusion

Description

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!

Core stream fusion functionality for text.

Synopsis

- stream :: Text -> Stream Char
- unstream :: Stream Char -> Text
- unstreamChunks :: Int -> Stream Char -> Text
- length :: Stream Char -> Int64
- unfoldrN :: Int64 -> (a -> Maybe (Char, a)) -> a -> Stream Char
- index :: Stream Char -> Int64 -> Char
- countChar :: Char -> Stream Char -> Int64

# Documentation

stream :: Text -> Stream Char

O(n) Convert a `Text` into a 'Stream Char'.

unstream :: Stream Char -> Text

O(n) Convert a 'Stream Char' into a `Text`, using `defaultChunkSize`.

unstreamChunks :: Int -> Stream Char -> Text

O(n) Convert a 'Stream Char' into a `Text`, using the given chunk size.

length :: Stream Char -> Int64

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

unfoldrN :: Int64 -> (a -> Maybe (Char, a)) -> a -> Stream Char

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.

index :: Stream Char -> Int64 -> Char

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

countChar :: Char -> Stream Char -> Int64

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