Moduleghc-boot-9.14.1Haskell2010

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.

Contents

ShortText
Conversion to and from String
Operations

Synopsis

newtype ShortText
value singleton
value pack
value unpack
value codepointLength
value byteLength
value null
value splitFilePath
value head
value stripPrefix

Packageghc-boot-9.14.1
Exports10
LanguageHaskell2010
LicenceBSD-3-Clause
SourceShortText.hs

ShortText

newtypenewtype ShortText

Source#

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-boot-9.14.1 · GHC.Data.ShortText
Ord ShortTextDefined in ghc-boot-9.14.1 · GHC.Data.ShortText
Show ShortTextDefined in ghc-boot-9.14.1 · GHC.Data.ShortText
IsString ShortTextDefined in ghc-boot-9.14.1 · GHC.Data.ShortText
Semigroup ShortTextDefined in ghc-boot-9.14.1 · GHC.Data.ShortText
Monoid ShortTextDefined in ghc-boot-9.14.1 · GHC.Data.ShortText
NFData ShortTextDefined in ghc-boot-9.14.1 · GHC.Data.ShortText
Binary ShortTextDefined in ghc-boot-9.14.1 · GHC.Data.ShortText

Conversion to and from String

valuesingleton :: Char -> ShortText

Source#

Create a singleton

valuepack :: String -> ShortText

Source#

O(n) Convert a String into a ShortText.

valueunpack :: ShortText -> String

Source#

O(n) Convert a ShortText into a String.

Operations

valuecodepointLength :: ShortText -> Int

Source#

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

valuebyteLength :: ShortText -> Int

Source#

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

valuenull :: ShortText -> Bool

Source#

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

valuesplitFilePath :: ShortText -> [ShortText]

Source#

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

Source#

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

Source#

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.