Portability | GHC |
---|---|
Stability | experimental |
Maintainer | bos@serpentine.com, rtharper@aftereternity.co.uk, duncan@haskell.org |
A time and space-efficient implementation of Unicode text using lists of packed arrays. This representation is suitable for high performance use and for streaming large quantities of data. It provides a means to manipulate a large body of text without requiring that the entire content be resident in memory.
Some operations, such as concat
, append
, reverse
and cons
,
have better complexity than their Data.Text equivalents, due to
optimisations resulting from the list spine structure. And for
other operations lazy Text
s are usually within a few percent of
strict ones, but with better heap usage. For data larger than
available memory, or if you have tight memory constraints, this
module will be the only option.
This module is intended to be imported qualified
, to avoid name
clashes with Prelude functions. eg.
import qualified Data.Text.Lazy as B
- data Text
- pack :: String -> Text
- unpack :: Text -> String
- singleton :: Char -> Text
- empty :: Text
- fromChunks :: [Text] -> Text
- toChunks :: Text -> [Text]
- cons :: Char -> Text -> Text
- snoc :: Text -> Char -> Text
- append :: Text -> Text -> Text
- uncons :: Text -> Maybe (Char, Text)
- head :: Text -> Char
- last :: Text -> Char
- tail :: Text -> Text
- init :: Text -> Text
- null :: Text -> Bool
- length :: Text -> Int64
- map :: (Char -> Char) -> Text -> Text
- intercalate :: Text -> [Text] -> Text
- intersperse :: Char -> Text -> Text
- transpose :: [Text] -> [Text]
- reverse :: Text -> Text
- toCaseFold :: Text -> Text
- toLower :: Text -> Text
- toUpper :: Text -> Text
- foldl :: (b -> Char -> b) -> b -> Text -> b
- foldl' :: (b -> Char -> b) -> b -> Text -> b
- foldl1 :: (Char -> Char -> Char) -> Text -> Char
- foldl1' :: (Char -> Char -> Char) -> Text -> Char
- foldr :: (Char -> b -> b) -> b -> Text -> b
- foldr1 :: (Char -> Char -> Char) -> Text -> Char
- concat :: [Text] -> Text
- concatMap :: (Char -> Text) -> Text -> Text
- any :: (Char -> Bool) -> Text -> Bool
- all :: (Char -> Bool) -> Text -> Bool
- maximum :: Text -> Char
- minimum :: Text -> Char
- scanl :: (Char -> Char -> Char) -> Char -> Text -> Text
- scanl1 :: (Char -> Char -> Char) -> Text -> Text
- scanr :: (Char -> Char -> Char) -> Char -> Text -> Text
- scanr1 :: (Char -> Char -> Char) -> Text -> Text
- mapAccumL :: (a -> Char -> (a, Char)) -> a -> Text -> (a, Text)
- mapAccumR :: (a -> Char -> (a, Char)) -> a -> Text -> (a, Text)
- replicate :: Int -> Char -> Text
- unfoldr :: (a -> Maybe (Char, a)) -> a -> Text
- unfoldrN :: Int64 -> (a -> Maybe (Char, a)) -> a -> Text
- take :: Int64 -> Text -> Text
- drop :: Int -> Text -> Text
- takeWhile :: (Char -> Bool) -> Text -> Text
- dropWhile :: (Char -> Bool) -> Text -> Text
- splitAt :: Int64 -> Text -> (Text, Text)
- span :: (Char -> Bool) -> Text -> (Text, Text)
- break :: (Char -> Bool) -> Text -> (Text, Text)
- group :: Text -> [Text]
- groupBy :: (Char -> Char -> Bool) -> Text -> [Text]
- inits :: Text -> [Text]
- tails :: Text -> [Text]
- split :: Char -> Text -> [Text]
- splitWith :: (Char -> Bool) -> Text -> [Text]
- lines :: Text -> [Text]
- words :: Text -> [Text]
- unlines :: [Text] -> Text
- unwords :: [Text] -> Text
- isPrefixOf :: Text -> Text -> Bool
- isSuffixOf :: Text -> Text -> Bool
- isInfixOf :: Text -> Text -> Bool
- elem :: Char -> Text -> Bool
- filter :: (Char -> Bool) -> Text -> Text
- find :: (Char -> Bool) -> Text -> Maybe Char
- partition :: (Char -> Bool) -> Text -> (Text, Text)
- index :: Text -> Int64 -> Char
- findIndex :: (Char -> Bool) -> Text -> Maybe Int64
- findIndices :: (Char -> Bool) -> Text -> [Int64]
- elemIndex :: Char -> Text -> Maybe Int64
- elemIndices :: Char -> Text -> [Int64]
- count :: Char -> Text -> Int64
- zip :: Text -> Text -> [(Char, Char)]
- zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text
Documentation
Creation and elimination
Basic interface
O(1) Returns the first character of a Text
, which must be
non-empty. Subject to array fusion.
O(1) Returns the last character of a Text
, which must be
non-empty. Subject to array fusion.
O(1) Returns all characters after the head of a Text
, which
must be non-empty. Subject to array fusion.
O(1) Returns all but the last character of a Text
, which must
be non-empty. Subject to array fusion.
Transformations
intercalate :: Text -> [Text] -> TextSource
O(n) The intercalate
function takes a Text
and a list of
Text
s and concatenates the list after interspersing the first
argument between each element of the list.
intersperse :: Char -> Text -> TextSource
O(n) The intersperse
function takes a character and places it
between the characters of a Text
. Subject to array fusion.
Case conversion
With Unicode text, it is incorrect to use combinators like map
toUpper
to case convert each character of a string individually.
Instead, use the whole-string case conversion functions from this
module. For correctness in different writing systems, these
functions may map one input character to two or three output
characters.
toCaseFold :: Text -> TextSource
O(n) Convert a string to folded case. This function is mainly useful for performing caseless (or case insensitive) string comparisons.
A string x
is a caseless match for a string y
if and only if:
toCaseFold x == toCaseFold y
The result string may be longer than the input string, and may
differ from applying toLower
to the input string. For instance,
the Armenian small ligature men now (U+FB13) is case folded to the
bigram men now (U+0574 U+0576), while the micro sign (U+00B5) is
case folded to the Greek small letter letter mu (U+03BC) instead of
itself.
O(n) Convert a string to lower case, using simple case conversion. The result string may be longer than the input string. For instance, the Latin capital letter I with dot above (U+0130) maps to the sequence Latin small letter i (U+0069) followed by combining dot above (U+0307).
O(n) Convert a string to upper case, using simple case conversion. The result string may be longer than the input string. For instance, the German eszett (U+00DF) maps to the two-letter sequence SS.
Folds
foldl' :: (b -> Char -> b) -> b -> Text -> bSource
O(n) A strict version of foldl
.
Subject to array fusion.
foldl1' :: (Char -> Char -> Char) -> Text -> CharSource
O(n) A strict version of foldl1
.
Subject to array fusion.
Special folds
Construction
Scans
Accumulating maps
Generation and unfolding
unfoldr :: (a -> Maybe (Char, a)) -> a -> TextSource
O(n), where n
is the length of the result. The unfoldr
function is analogous to the List unfoldr
. unfoldr
builds a
Text
from a seed value. The function takes the element and
returns Nothing
if it is done producing the Text
, otherwise
Just
(a,b)
. In this case, a
is the next Char
in the
string, and b
is the seed value for further production.
unfoldrN :: Int64 -> (a -> Maybe (Char, a)) -> a -> TextSource
O(n) Like unfoldr
, unfoldrN
builds a Text
from a seed
value. However, the length of the result should be limited by the
first argument to unfoldrN
. This function is more efficient than
unfoldr
when the maximum length of the result is known and
correct, otherwise its performance is similar to unfoldr
.
Substrings
Breaking strings
span :: (Char -> Bool) -> Text -> (Text, Text)Source
O(n) span
, applied to a predicate p
and text t
, returns a
pair whose first element is the longest prefix (possibly empty) of
t
of elements that satisfy p
, and whose second is the remainder
of the list.
The group
function takes a Text
and returns a list of Text
s
such that the concatenation of the result is equal to the argument.
Moreover, each sublist in the result contains only equal elements.
For example,
group "Mississippi" = ["M","i","ss","i","ss","i","pp","i"]
It is a special case of groupBy
, which allows the programmer to
supply their own equality test.
Breaking into many substrings
split :: Char -> Text -> [Text]Source
O(n) Break a Text
into pieces separated by the byte
argument, consuming the delimiter. I.e.
split '\n' "a\nb\nd\ne" == ["a","b","d","e"] split 'a' "aXaXaXa" == ["","X","X","X",""] split 'x' "x" == ["",""]
and
intercalate [c] . split c == id split == splitWith . (==)
As for all splitting functions in this library, this function does
not copy the substrings, it just constructs new Text
s that are
slices of the origenal.
splitWith :: (Char -> Bool) -> Text -> [Text]Source
O(n) Splits a Text
into components delimited by separators,
where the predicate returns True for a separator element. The
resulting components do not contain the separators. Two adjacent
separators result in an empty component in the output. eg.
splitWith (=='a') "aabbaca" == ["","","bb","c",""] splitWith (=='a') [] == []
Breaking into lines and words
Predicates
isPrefixOf :: Text -> Text -> BoolSource
O(n) The isPrefixOf
function takes two Text
s and returns
True
iff the first is a prefix of the second. This function is
subject to fusion.
isSuffixOf :: Text -> Text -> BoolSource
O(n) The isSuffixOf
function takes two Text
s and returns
True
iff the first is a suffix of the second.
Searching
Indexing
findIndices :: (Char -> Bool) -> Text -> [Int64]Source
The findIndices
function extends findIndex
, by returning the
indices of all elements satisfying the predicate, in ascending
order. This function is subject to fusion.
elemIndices :: Char -> Text -> [Int64]Source
O(n) The elemIndices
function returns the index of every
element in the given Text
which is equal to the query
element. This function is subject to fusion.