hw-polysemy-0.2.14.0: Opinionated polysemy library
Safe HaskellSafe-Inferred
LanguageHaskell2010

HaskellWorks.Polysemy.Data.Text.Strict

Synopsis

Documentation

data Text #

A space efficient, packed, unboxed Unicode text type.

Instances

Instances details
FromJSON Text 
Instance details

Defined in Data.Aeson.Types.FromJSON

FromJSONKey Text 
Instance details

Defined in Data.Aeson.Types.FromJSON

ToJSON Text 
Instance details

Defined in Data.Aeson.Types.ToJSON

ToJSONKey Text 
Instance details

Defined in Data.Aeson.Types.ToJSON

Chunk Text 
Instance details

Defined in Data.Attoparsec.Internal.Types

Associated Types

type ChunkElem Text #

Hashable Text 
Instance details

Defined in Data.Hashable.Class

Methods

hashWithSalt :: Int -> Text -> Int #

hash :: Text -> Int #

ToString Text Source # 
Instance details

Defined in HaskellWorks.Polysemy.String

Methods

toString :: Text -> String Source #

type ChunkElem Text 
Instance details

Defined in Data.Attoparsec.Internal.Types

type State Text 
Instance details

Defined in Data.Attoparsec.Internal.Types

type State Text = Buffer
type Item Text 
Instance details

Defined in Data.Text

type Item Text = Char

Creation and elimination

pack :: String -> Text #

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"

unpack :: Text -> String #

O(n) Convert a Text into a String.

singleton :: Char -> Text #

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

empty :: Text #

O(1) The empty Text.

Basic interface

length :: Text -> Int #

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

compareLength :: Text -> Int -> Ordering #

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.

null :: Text -> Bool #

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

Transformations

map :: (Char -> Char) -> Text -> Text #

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.

intercalate :: Text -> [Text] -> Text #

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"

intersperse :: Char -> Text -> Text #

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.

transpose :: [Text] -> [Text] #

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

reverse :: Text -> Text #

O(n) Reverse the characters of a string.

Example:

>>> T.reverse "desrever"
"reversed"

replace #

Arguments

:: HasCallStack 
=> Text

needle to search for. If this string is empty, an error will occur.

-> Text

replacement to replace needle with.

-> Text

haystack in which to search.

-> Text 

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

Case conversion

toCaseFold :: Text -> Text #

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.

toLower :: Text -> Text #

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

toUpper :: Text -> Text #

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

toTitle :: Text -> Text #

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

Justification

justifyLeft :: Int -> Char -> Text -> Text #

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"

justifyRight :: Int -> Char -> Text -> Text #

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"

center :: Int -> Char -> Text -> Text #

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"

Folds

foldl :: (a -> Char -> a) -> a -> Text -> a #

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.

foldl' :: (a -> Char -> a) -> a -> Text -> a #

O(n) A strict version of foldl.

foldl1 :: HasCallStack => (Char -> Char -> Char) -> Text -> Char #

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

foldl1' :: HasCallStack => (Char -> Char -> Char) -> Text -> Char #

O(n) A strict version of foldl1.

foldr :: (Char -> a -> a) -> a -> Text -> 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).

foldr' :: (Char -> a -> a) -> a -> Text -> a #

O(n) A strict version of foldr.

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

Since: text-2.0.1

foldr1 :: HasCallStack => (Char -> Char -> Char) -> Text -> Char #

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

Special folds

concat :: [Text] -> Text #

O(n) Concatenate a list of Texts.

concatMap :: (Char -> Text) -> Text -> Text #

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

any :: (Char -> Bool) -> Text -> Bool #

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

all :: (Char -> Bool) -> Text -> Bool #

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

maximum :: HasCallStack => Text -> Char #

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

minimum :: HasCallStack => Text -> Char #

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

isAscii :: Text -> Bool #

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

Construction

Scans

scanl :: (Char -> Char -> Char) -> Char -> Text -> Text #

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

scanl1 :: (Char -> Char -> Char) -> Text -> Text #

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, ...]

scanr :: (Char -> Char -> Char) -> Char -> Text -> 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

scanr1 :: (Char -> Char -> Char) -> Text -> Text #

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

Accumulating maps

mapAccumL :: (a -> Char -> (a, Char)) -> a -> Text -> (a, Text) #

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.

mapAccumR :: (a -> Char -> (a, Char)) -> a -> Text -> (a, Text) #

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.

Generation and unfolding

replicate :: Int -> Text -> Text #

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

unfoldr :: (a -> Maybe (Char, a)) -> a -> Text #

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.

unfoldrN :: Int -> (a -> Maybe (Char, a)) -> a -> Text #

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.

Substrings

Breaking strings

take :: Int -> Text -> Text #

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.

takeEnd :: Int -> Text -> Text #

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

drop :: Int -> Text -> Text #

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.

dropEnd :: Int -> Text -> Text #

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

takeWhile :: (Char -> Bool) -> Text -> Text #

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

takeWhileEnd :: (Char -> Bool) -> Text -> Text #

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

dropWhile :: (Char -> Bool) -> Text -> Text #

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

dropWhileEnd :: (Char -> Bool) -> Text -> Text #

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"

dropAround :: (Char -> Bool) -> Text -> Text #

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.

strip :: Text -> Text #

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

dropAround isSpace

stripStart :: Text -> Text #

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

dropWhile isSpace

stripEnd :: Text -> Text #

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

dropWhileEnd isSpace

splitAt :: Int -> Text -> (Text, 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).

breakOn :: HasCallStack => Text -> Text -> (Text, Text) #

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

breakOnEnd :: HasCallStack => Text -> Text -> (Text, Text) #

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

break :: (Char -> Bool) -> Text -> (Text, Text) #

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

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

span :: (Char -> Bool) -> Text -> (Text, Text) #

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

spanM :: Monad m => (Char -> m Bool) -> Text -> m (Text, Text) #

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

spanEndM :: Monad m => (Char -> m Bool) -> Text -> m (Text, Text) #

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

group :: Text -> [Text] #

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

groupBy :: (Char -> Char -> Bool) -> Text -> [Text] #

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

inits :: Text -> [Text] #

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

tails :: Text -> [Text] #

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

Breaking into many substrings

splitOn #

Arguments

:: HasCallStack 
=> Text

String to split on. If this string is empty, an error will occur.

-> Text

Input text.

-> [Text] 

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

split :: (Char -> Bool) -> Text -> [Text] #

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') ""
[""]

chunksOf :: Int -> Text -> [Text] #

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

Breaking into lines and words

lines :: Text -> [Text] #

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.

words :: Text -> [Text] #

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

unlines :: [Text] -> Text #

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

unwords :: [Text] -> Text #

O(n) Joins words using single space characters.

Predicates

isPrefixOf :: Text -> Text -> Bool #

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

isSuffixOf :: Text -> Text -> Bool #

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

isInfixOf :: Text -> Text -> Bool #

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

View patterns

stripPrefix :: Text -> Text -> Maybe Text #

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

stripSuffix :: Text -> Text -> Maybe Text #

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

commonPrefixes :: Text -> Text -> Maybe (Text, Text, Text) #

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

Searching

filter :: (Char -> Bool) -> Text -> Text #

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

breakOnAll #

Arguments

:: HasCallStack 
=> Text

needle to search for

-> Text

haystack in which to search

-> [(Text, Text)] 

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.

find :: (Char -> Bool) -> Text -> Maybe Char #

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.

elem :: Char -> Text -> Bool #

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.

partition :: (Char -> Bool) -> Text -> (Text, Text) #

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)

Indexing

index :: HasCallStack => Text -> Int -> Char #

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

findIndex :: (Char -> Bool) -> Text -> Maybe Int #

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.

count :: HasCallStack => Text -> Text -> Int #

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

Zipping

zip :: Text -> Text -> [(Char, Char)] #

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.

zipWith :: (Char -> Char -> Char) -> Text -> Text -> Text #

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.

File reading

readFile :: HasCallStack => Member (Error IOException) r => Member (Embed IO) r => Member Log r => FilePath -> Sem r Text Source #

Read the contents of the filePath file.