Moduleghc-lib-parser-9.14.1.20251220GHC2021

GHC.Data.ShortText

An Unicode string for internal GHC use. Meant to replace String in places where being a lazy linked is not very useful and a more memory efficient data structure is desirable.

1 type
9 values

Packageghc-lib-parser-9.14.1.20251220
Exports10
LanguageGHC2021
LicenceBSD-3-Clause
SourceShortText.hs

ShortText

1 declaration

newtypenewtype ShortText

A ShortText is a modified UTF-8 encoded string meant for short strings like file paths, module descriptions, etc.

Constructors

ShortText
- contents :: ShortByteString

Instances8Eq, Ord, Show, IsString, Semigroup, Monoid, …

Eq ShortTextDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Data.ShortText
Ord ShortTextDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Data.ShortText
Show ShortTextDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Data.ShortText
IsString ShortTextDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Data.ShortText
Semigroup ShortTextDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Data.ShortText
Monoid ShortTextDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Data.ShortText
NFData ShortTextDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Data.ShortText
Binary ShortTextDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Data.ShortText

Conversion to and from String

valuesingleton :: Char -> ShortText

Create a singleton

valuepack :: String -> ShortText

O(n) Convert a String into a ShortText.

valueunpack :: ShortText -> String

O(n) Convert a ShortText into a String.

Operations

valuecodepointLength :: ShortText -> Int

O(n) Returns the length of the ShortText in characters.

valuebyteLength :: ShortText -> Int

O(1) Returns the length of the ShortText in bytes.

valuenull :: ShortText -> Bool

O(1) Test whether the ShortText is the empty string.

valuesplitFilePath :: ShortText -> [ShortText]

O(n) Split a ShortText representing a file path into its components by separating on the file separator characters for this platform.

valuehead :: ShortText -> Char

O(1) Returns the first UTF-8 codepoint in the ShortText. Depending on the string in question, this may or may not be the actual first character in the string due to Unicode non-printable characters.

valuestripPrefix :: ShortText -> ShortText -> Maybe ShortText

O(n) The stripPrefix function takes two ShortTexts and returns Just the remainder of the second iff the first is its prefix, and otherwise Nothing.