Documentation

Convenience class for creating MisoString from other string-like types

Class from safely parsing MisoString

Parses a MisoString, throws an error when decoding fails. Use fromMisoStringEither for as a safe alternative.

String type swappable based on compiler

O(n) zip takes two Texts and returns a list of corresponding pairs of bytes. If one input Text is short, excess elements of the longer Text are discarded. This is equivalent to a pair of unpack operations.

O(n) foldl, applied to a binary operator, a starting value (typically the left-identity of the operator), and a Text, reduces the Text using the binary operator, from left to right.

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.

>>> split (=='a') "aabbaca"
["","","bb","c",""]

>>> split (=='a') ""
[""]

O(n) foldr, applied to a binary operator, a starting value (typically the right-identity of the operator), and a Text, reduces the Text using the binary operator, from right to left.

If the binary operator is strict in its second argument, use foldr' instead.

foldr is lazy like foldr for lists: evaluation actually traverses the Text from left to right, only as far as it needs to.

For example, head can be defined with O(1) complexity using foldr:

head :: Text -> Char
head = foldr const (error "head empty")

Searches from left to right with short-circuiting behavior can also be defined using foldr (e.g., any, all, find, elem).

O(n) map f t is the Text obtained by applying f to each element of t.

Example:

>>> let message = pack "I am not angry. Not at all."
>>> T.map (\c -> if c == '.' then '!' else c) message
"I am not angry! Not at all!"

Performs replacement on invalid scalar values.

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

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".

O(1) The empty Text.

A space efficient, packed, unboxed Unicode text type.

O(1) Tests whether a Text is empty or not.

O(1) Convert a character into a Text. Performs replacement on invalid scalar values.

O(n) A strict version of foldr.

foldr' evaluates as a right-to-left traversal using constant stack space.

Since: text-2.0.1

O(n) A strict version of foldl.

O(n) filter, applied to a predicate and a Text, returns a Text containing those characters that satisfy the predicate.

Bidirectional pattern synonym for empty and null (both O(1)), to be used together with (:<) or (:>).

Since: text-2.1.2

O(n) Convert a string to lower case, using simple case conversion.

The result string may be longer than the input string. For instance, "İ" (Latin capital letter I with dot above, U+0130) maps to the sequence "i" (Latin small letter i, U+0069) followed by " ̇" (combining dot above, U+0307).

O(n) takeWhile, applied to a predicate p and a Text, returns the longest prefix (possibly empty) of elements that satisfy p.

O(n) take n, applied to a Text, returns the prefix of the Text of length n, or the Text itself if n is greater than the length of the Text.

O(n+m) The count function returns the number of times the query string appears in the given Text. An empty query string is invalid, and will cause an error to be raised.

In (unlikely) bad cases, this function's time complexity degrades towards O(n*m).

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. Performs replacement on invalid scalar values.

O(n) The transpose function transposes the rows and columns of its Text argument. Note that this function uses pack, unpack, and the list version of transpose, and is thus not very efficient.

Examples:

>>> transpose ["green","orange"]
["go","rr","ea","en","ng","e"]

>>> transpose ["blue","red"]
["br","le","ud","e"]

O(n) Convert a null-terminated modified UTF-8 (but with a standard UTF-8 representation of characters from supplementary planes) string to a Text. Counterpart to unpackCStringUtf8#. No validation is performed, malformed input can lead to memory access violation.

Since: text-1.2.1.1

O(n) Concatenate a list of Texts.

O(1) Returns the first character of a Text, which must be non-empty. This is a partial function, consider using uncons instead.

O(1) Returns the first character and rest of a Text, or Nothing if empty.

O(1) Returns all but the last character and the last character of a Text, or Nothing if empty.

Since: text-1.2.3.0

O(1) Returns all characters after the head of a Text, which must be non-empty. This is a partial function, consider using uncons instead.

O(1) Returns the last character of a Text, which must be non-empty. This is a partial function, consider using unsnoc instead.

O(1) Returns all but the last character of a Text, which must be non-empty. This is a partial function, consider using unsnoc instead.

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

O(n) A variant of foldl that has no starting value argument, and thus must be applied to a non-empty Text.

O(n) A strict version of foldl1.

O(n) scanl is similar to foldl, but returns a list of successive reduced values from the left. Performs replacement on invalid scalar values.

scanl f z [x1, x2, ...] == [z, z `f` x1, (z `f` x1) `f` x2, ...]

Properties

head (scanl f z xs) = z

last (scanl f z xs) = foldl f z xs

O(n) scanl1 is a variant of scanl that has no starting value argument. Performs replacement on invalid scalar values.

scanl1 f [x1, x2, ...] == [x1, x1 `f` x2, ...]

O(n) A variant of foldr that has no starting value argument, and thus must be applied to a non-empty Text.

O(n) scanr is the right-to-left dual of scanl. Performs replacement on invalid scalar values.

scanr f v == reverse . scanl (flip f) v . reverse

O(n) scanr1 is a variant of scanr that has no starting value argument. Performs replacement on invalid scalar values.

O(n) maximum returns the maximum value from a Text, which must be non-empty.

O(n) minimum returns the minimum value from a Text, which must be non-empty.

O(n*m) replicate n t is a Text consisting of the input t repeated n times.

O(n) dropWhile p t returns the suffix remaining after takeWhile p t.

O(n) drop n, applied to a Text, returns the suffix of the Text after the first n characters, or the empty Text if n is greater than the length of the Text.

O(n) splitAt n t returns a pair whose first element is a prefix of t of length n, and whose second is the remainder of the string. It is equivalent to (take n t, drop n t).

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 text.

>>> T.span (=='0') "000AB"
("000","AB")

O(n) break is like span, but the prefix returned is over elements that fail the predicate p.

>>> T.break (=='c') "180cm"
("180","cm")

O(n) any p t determines whether any character in the Text t satisfies the predicate p.

O(n) all p t determines whether all characters in the Text t satisfy the predicate p.

O(n) The elem function takes a character and a Text, and returns True if the element is found in the given Text, or False otherwise.

O(n) Map a function over a Text that results in a Text, and concatenate the results.

O(n) zipWith generalises zip by zipping with the function given as the first argument, instead of a tupling function. Performs replacement on invalid scalar values.

O(n) Test whether Text contains only ASCII code-points (i.e. only U+0000 through U+007F).

This is a more efficient version of all isAscii.

>>> isAscii ""
True

>>> isAscii "abc\NUL"
True

>>> isAscii "abcd€"
False

isAscii t == all (< '\x80') t

Since: text-2.0.2

O(n) Convert a string to title case, using simple case conversion.

The first letter (as determined by isLetter) of the input is converted to title case, as is every subsequent letter that immediately follows a non-letter. Every letter that immediately follows another letter is converted to lower case.

This function is not idempotent. Consider lower-case letter ʼn (U+0149 LATIN SMALL LETTER N PRECEDED BY APOSTROPHE). Then toTitle "ʼn" = "ʼN": the first (and the only) letter of the input is converted to title case, becoming two letters. Now ʼ (U+02BC MODIFIER LETTER APOSTROPHE) is a modifier letter and as such is recognised as a letter by isLetter, so toTitle "ʼN" = "'n".

The result string may be longer than the input string. For example, the Latin small ligature fl (U+FB02) is converted to the sequence Latin capital letter F (U+0046) followed by Latin small letter l (U+006C).

Note: this function does not take language or culture specific rules into account. For instance, in English, different style guides disagree on whether the book name "The Hill of the Red Fox" is correctly title cased—but this function will capitalize every word.

Since: text-1.0.0.0

O(n) The find function takes a predicate and a Text, and returns the first element matching the predicate, or Nothing if there is no such element.

O(n) dropWhileEnd p t returns the prefix remaining after dropping characters that satisfy the predicate p from the end of t.

Examples:

>>> dropWhileEnd (=='.') "foo..."
"foo"

O(n) Return the suffix of the second string if its prefix matches the entire first string.

Examples:

>>> stripPrefix "foo" "foobar"
Just "bar"

>>> stripPrefix ""    "baz"
Just "baz"

>>> stripPrefix "foo" "quux"
Nothing

This is particularly useful with the ViewPatterns extension to GHC, as follows:

{-# LANGUAGE ViewPatterns #-}
import Data.Text as T

fnordLength :: Text -> Int
fnordLength (stripPrefix "fnord" -> Just suf) = T.length suf
fnordLength _                                 = -1

O(n) The findIndex function takes a predicate and a Text and returns the index of the first element in the Text satisfying the predicate.

O(n) The isPrefixOf function takes two Texts and returns True if and only if the first is a prefix of the second.

O(n) The isSuffixOf function takes two Texts and returns True if and only if the first is a suffix of the second.

O(n+m) The isInfixOf function takes two Texts and returns True if and only if the first is contained, wholly and intact, anywhere within the second.

In (unlikely) bad cases, this function's time complexity degrades towards O(n*m).

O(n) The intersperse function takes a character and places it between the characters of a Text.

Example:

>>> T.intersperse '.' "SHIELD"
"S.H.I.E.L.D"

Performs replacement on invalid scalar values.

O(n) The intercalate function takes a Text and a list of Texts and concatenates the list after interspersing the first argument between each element of the list.

Example:

>>> T.intercalate "NI!" ["We", "seek", "the", "Holy", "Grail"]
"WeNI!seekNI!theNI!HolyNI!Grail"

O(n) The partition function takes a predicate and a Text, and returns the pair of Texts with elements which do and do not satisfy the predicate, respectively; i.e.

partition p t == (filter p t, filter (not . p) t)

O(n) Group characters in a string by equality.

O(n) Group characters in a string according to a predicate.

O(n) Return all initial segments of the given Text, shortest first.

O(n) Return all final segments of the given Text, longest first.

O(n) Breaks a Text up into a list of Texts at newline characters '\n' (LF, line feed). The resulting strings do not contain newlines.

lines does not treat '\r' (CR, carriage return) as a newline character.

O(n) Joins lines, after appending a terminating newline to each.

O(n) Breaks a Text up into a list of words, delimited by Chars representing white space.

O(n) Joins words using single space characters.

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. Performs replacement on invalid scalar values.

The mapAccumR function behaves like a combination of map and a strict foldr; it applies a function to each element of a Text, passing an accumulating parameter from right to left, and returning a final value of this accumulator together with the new Text. Performs replacement on invalid scalar values.

O(n) Adds a character to the front of a Text. This function is more costly than its List counterpart because it requires copying a new array. Performs replacement on invalid scalar values.

O(n) Appends one Text to the other by copying both of them into a new Text.

O(min(n,c)) Compare the count of characters in a Text to a number.

compareLength t c = compare (length t) c

This function gives the same answer as comparing against the result of length, but can short circuit if the count of characters is greater than the number, and hence be more efficient.

O(n) Convert a String into a Text. Performs replacement on invalid scalar values, so unpack . pack is not id:

>>> Data.Text.unpack (pack "\55555")
"\65533"

O(n) Convert a Text into a String.

O(n) Adds a character to the end of a Text. This copies the entire array in the process. Performs replacement on invalid scalar values.

O(n) takeEnd n t returns the suffix remaining after taking n characters from the end of t.

Examples:

>>> takeEnd 3 "foobar"
"bar"

Since: text-1.1.1.0

O(n) takeWhileEnd, applied to a predicate p and a Text, returns the longest suffix (possibly empty) of elements that satisfy p. Examples:

>>> takeWhileEnd (=='o') "foo"
"oo"

Since: text-1.2.2.0

O(n) dropEnd n t returns the prefix remaining after dropping n characters from the end of t.

Examples:

>>> dropEnd 3 "foobar"
"foo"

Since: text-1.1.1.0

O(n) Return the prefix of the second string if its suffix matches the entire first string.

Examples:

>>> stripSuffix "bar" "foobar"
Just "foo"

>>> stripSuffix ""    "baz"
Just "baz"

>>> stripSuffix "foo" "quux"
Nothing

This is particularly useful with the ViewPatterns extension to GHC, as follows:

{-# LANGUAGE ViewPatterns #-}
import Data.Text as T

quuxLength :: Text -> Int
quuxLength (stripSuffix "quux" -> Just pre) = T.length pre
quuxLength _                                = -1

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. Performs replacement on invalid scalar values.

O(n) Return all initial segments of the given Text, shortest first.

Since: text-2.1.2

O(n) Return all final segments of the given Text, longest first.

Since: text-2.1.2

O(n) Make a distinct copy of the given string, sharing no storage with the original string.

As an example, suppose you read a large string, of which you need only a small portion. If you do not use copy, the entire original array will be kept alive in memory by the smaller string. Making a copy "breaks the link" to the original array, allowing it to be garbage collected if there are no other live references to it.

O(n) Remove leading and trailing white space from a string. Equivalent to:

dropAround isSpace

Bidirectional pattern synonym for snoc (O(n)) and unsnoc (O(1)) to be used together with Empty.

Since: text-2.1.2

Bidirectional pattern synonym for cons (O(n)) and uncons (O(1)), to be used together with Empty.

Since: text-2.1.2

O(n) Splits a Text into components of length k. The last element may be shorter than the other chunks, depending on the length of the input. Examples:

>>> chunksOf 3 "foobarbaz"
["foo","bar","baz"]

>>> chunksOf 4 "haskell.org"
["hask","ell.","org"]

O(n) Convert a string to folded case.

This function is mainly useful for performing caseless (also known as 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 sequence "մ" (men, U+0574) followed by "ն" (now, U+0576), while the Greek "µ" (micro sign, U+00B5) is case folded to "μ" (small letter mu, U+03BC) instead of itself.

O(m+n) Replace every non-overlapping occurrence of needle in haystack with replacement.

This function behaves as though it was defined as follows:

replace needle replacement haystack =
  intercalate replacement (splitOn needle haystack)

As this suggests, each occurrence is replaced exactly once. So if needle occurs in replacement, that occurrence will not itself be replaced recursively:

>>> replace "oo" "foo" "oo"
"foo"

In cases where several instances of needle overlap, only the first one will be replaced:

>>> replace "ofo" "bar" "ofofo"
"barfo"

In (unlikely) bad cases, this function's time complexity degrades towards O(n*m).

O(n) Left-justify a string to the given length, using the specified fill character on the right. Performs replacement on invalid scalar values.

Examples:

>>> justifyLeft 7 'x' "foo"
"fooxxxx"

>>> justifyLeft 3 'x' "foobar"
"foobar"

O(n) Right-justify a string to the given length, using the specified fill character on the left. Performs replacement on invalid scalar values.

Examples:

>>> justifyRight 7 'x' "bar"
"xxxxbar"

>>> justifyRight 3 'x' "foobar"
"foobar"

O(n) Center a string to the given length, using the specified fill character on either side. Performs replacement on invalid scalar values.

Examples:

>>> center 8 'x' "HS"
"xxxHSxxx"

O(n) dropAround p t returns the substring remaining after dropping characters that satisfy the predicate p from both the beginning and end of t.

O(n) Remove leading white space from a string. Equivalent to:

dropWhile isSpace

O(n) Remove trailing white space from a string. Equivalent to:

dropWhileEnd isSpace

O(m+n) Break a Text into pieces separated by the first Text argument (which cannot be empty), consuming the delimiter. An empty delimiter is invalid, and will cause an error to be raised.

Examples:

>>> splitOn "\r\n" "a\r\nb\r\nd\r\ne"
["a","b","d","e"]

>>> splitOn "aaa"  "aaaXaaaXaaaXaaa"
["","X","X","X",""]

>>> splitOn "x"    "x"
["",""]

and

intercalate s . splitOn s         == id
splitOn (singleton c)             == split (==c)

(Note: the string s to split on above cannot be empty.)

In (unlikely) bad cases, this function's time complexity degrades towards O(n*m).

O(n+m) Find the first instance of needle (which must be non-null) in haystack. The first element of the returned tuple is the prefix of haystack before needle is matched. The second is the remainder of haystack, starting with the match.

Examples:

>>> breakOn "::" "a::b::c"
("a","::b::c")

>>> breakOn "/" "foobar"
("foobar","")

Laws:

append prefix match == haystack
  where (prefix, match) = breakOn needle haystack

If you need to break a string by a substring repeatedly (e.g. you want to break on every instance of a substring), use breakOnAll instead, as it has lower startup overhead.

In (unlikely) bad cases, this function's time complexity degrades towards O(n*m).

O(n+m) Similar to breakOn, but searches from the end of the string.

The first element of the returned tuple is the prefix of haystack up to and including the last match of needle. The second is the remainder of haystack, following the match.

>>> breakOnEnd "::" "a::b::c"
("a::b::","c")

O(n+m) Find all non-overlapping instances of needle in haystack. Each element of the returned list consists of a pair:

• The entire string prior to the kth match (i.e. the prefix)
• The kth match, followed by the remainder of the string

Examples:

>>> breakOnAll "::" ""
[]

>>> breakOnAll "/" "a/b/c/"
[("a","/b/c/"),("a/b","/c/"),("a/b/c","/")]

In (unlikely) bad cases, this function's time complexity degrades towards O(n*m).

The needle parameter may not be empty.

O(n) Find the longest non-empty common prefix of two strings and return it, along with the suffixes of each string at which they no longer match.

If the strings do not have a common prefix or either one is empty, this function returns Nothing.

Examples:

>>> commonPrefixes "foobar" "fooquux"
Just ("foo","bar","quux")

>>> commonPrefixes "veeble" "fetzer"
Nothing

>>> commonPrefixes "" "baz"
Nothing

O(n) A monadic version of foldl'.

Since: text-2.1.2

Type synonym for the strict flavour of Text.

O(n) Convert a null-terminated ASCII string to a Text. Counterpart to unpackCString#. No validation is performed, malformed input can lead to memory access violation.

Since: text-2.0

O(n) If t is long enough to contain n characters, measureOff n t returns a non-negative number, measuring their size in Word8. Otherwise, if t is shorter, return a non-positive number, which is a negated total count of Char available in t. If t is empty or n = 0, return 0.

This function is used to implement take, drop, splitAt and length and is useful on its own in streaming and parsing libraries.

Since: text-2.0

O(length of prefix) spanM, applied to a monadic predicate p, a text t, returns a pair (t1, t2) where t1 is the longest prefix of t whose elements satisfy p, and t2 is the remainder of the text.

>>> T.spanM (\c -> state $ \i -> (fromEnum c == i, i+1)) "abcefg" `runState` 97
(("abc","efg"),101)

span is spanM specialized to Identity:

-- for all p :: Char -> Bool
span p = runIdentity . spanM (pure . p)

Since: text-2.0.1

O(length of suffix) spanEndM, applied to a monadic predicate p, a text t, returns a pair (t1, t2) where t2 is the longest suffix of t whose elements satisfy p, and t1 is the remainder of the text.

>>> T.spanEndM (\c -> state $ \i -> (fromEnum c == i, i-1)) "tuvxyz" `runState` 122
(("tuv","xyz"),118)

spanEndM p . reverse = fmap (bimap reverse reverse) . spanM p

Since: text-2.0.1

Convenience function, shorthand for toMisoString