O(n) Returns the first word, or the original text if no word boundary is encountered. Subject to fusion.
Moduletext-manipulate-0.3.1.0Haskell2010
Data.Text.Manipulate
Manipulate identifiers and structurally non-complex pieces of text by delimiting word boundaries via a combination of whitespace, control-characters, and case-sensitivity.
Assumptions have been made about word boundary characteristics inherint in predominantely English text, please see individual function documentation for further details and behaviour.
Contents
Synopsis
- value takeWord
- value dropWord
- value stripWord
- value breakWord
- value splitWords
- value lowerHead
- value upperHead
- value mapHead
- value indentLines
- value prependLines
- value toEllipsis
- value toEllipsisWith
- value toAcronym
- value toOrdinal
- value toTitle
- value toCamel
- value toPascal
- value toSnake
- value toSpinal
- value toTrain
- value isBoundary
- value isWordBoundary
- Packagetext-manipulate-0.3.1.0
- Exports22
- LanguageHaskell2010
- LicenceMPL-2.0
- SourceManipulate.hs
Strict vs lazy types
This library provides functions for manipulating both strict and lazy Text types. The strict functions are provided by the Data.Text.Manipulate module, while the lazy functions are provided by the Data.Text.Lazy.Manipulate module.
Unicode
Fusion
Many functions in this module are subject to fusion, meaning that a pipeline of such functions will usually allocate at most one Text value.
Functions that can be fused by the compiler are documented with the phrase Subject to fusion.
Subwords
Removing words
O(n) Return the suffix after dropping the first word. If no word boundary is encountered, the result will be empty. Subject to fusion.
O(n) Return the suffix after removing the first word, or Nothing if no word boundary is encountered.
stripWord "HTML5Spaghetti"Just "Spaghetti"
stripWord "noboundaries"Nothing
Breaking on words
Break a piece of text after the first word boundary is encountered.
breakWord "PascalCasedVariable"("Pacal", "CasedVariable")
breakWord "spinal-cased-variable"("spinal", "cased-variable")
O(n) Split into a list of words delimited by boundaries.
splitWords "SupercaliFrag_ilistic"["Supercali","Frag","ilistic"]
Character manipulation
Lowercase the first character of a piece of text.
lowerHead "Title Cased""title Cased"
Uppercase the first character of a piece of text.
upperHead "snake_cased""Snake_cased"
Apply a function to the first character of a piece of text.
Line manipulation
Indent newlines by the given number of spaces.
See: prependLines
Prepend newlines with the given separator
Ellipsis
O(n) Truncate text to a specific length. If the text was truncated the ellipsis sign "..." will be appended.
See: toEllipsisWith
O(n) Truncate text to a specific length. If the text was truncated the given ellipsis sign will be appended.
Acronyms
O(n) Create an adhoc acronym from a piece of cased text.
toAcronym "AmazonWebServices"Just "AWS"
toAcronym "Learn-You Some_Haskell"Just "LYSH"
toAcronym "this_is_all_lowercase"Nothing
Ordinals
Render an ordinal used to denote the position in an ordered sequence.
toOrdinal (101 :: Int)"101st"
toOrdinal (12 :: Int)"12th"
Casing
O(n) Convert casing to Title Cased Phrase. Subject to fusion.
O(n) Convert casing to camelCasedPhrase. Subject to fusion.
O(n) Convert casing to PascalCasePhrase. Subject to fusion.
O(n) Convert casing to snake_cased_phrase. Subject to fusion.
O(n) Convert casing to spinal-cased-phrase. Subject to fusion.
O(n) Convert casing to Train-Cased-Phrase. Subject to fusion.
Boundary predicates
Returns True for any boundary character.
Returns True for any boundary or uppercase character.