ghc-9.0.0.20201227: The GHC API
Safe HaskellNone
LanguageHaskell2010

GHC.Data.FastString

Description

There are two principal string types used internally by GHC:

FastString
  • A compact, hash-consed, representation of character strings.
  • Comparison is O(1), and you can get a Unique from them.
  • Generated by fsLit.
  • Turn into SDoc with ftext.
PtrString
  • Pointer and size of a Latin-1 encoded string.
  • Practically no operations.
  • Outputting them is fast.
  • Generated by sLit.
  • Turn into SDoc with ptext
  • Requires manual memory management. Improper use may lead to memory leaks or dangling pointers.
  • It assumes Latin-1 as the encoding, therefore it cannot represent arbitrary Unicode strings.

Use PtrString unless you want the facilities of FastString.

Synopsis

ByteString

bytesFS :: FastString -> ByteString Source #

Gives the UTF-8 encoded bytes corresponding to a FastString

fastStringToByteString :: FastString -> ByteString Source #

Deprecated: Use bytesFS instead

Gives the UTF-8 encoded bytes corresponding to a FastString

ShortByteString

FastZString

data FastZString Source #

Instances

Instances details
NFData FastZString # 
Instance details

Defined in GHC.Data.FastString

Methods

rnf :: FastZString -> () Source #

FastStrings

data FastString Source #

A FastString is a UTF-8 encoded string together with a unique ID. All FastStrings are stored in a global hashtable to support fast O(1) comparison.

It is also associated with a lazy reference to the Z-encoding of this string which is used by the compiler internally.

Constructors

FastString 

Fields

Instances

Instances details
Eq FastString # 
Instance details

Defined in GHC.Data.FastString

Data FastString # 
Instance details

Defined in GHC.Data.FastString

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FastString -> c FastString Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FastString Source #

toConstr :: FastString -> Constr Source #

dataTypeOf :: FastString -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FastString) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FastString) Source #

gmapT :: (forall b. Data b => b -> b) -> FastString -> FastString Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FastString -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FastString -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> FastString -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> FastString -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FastString -> m FastString Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FastString -> m FastString Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FastString -> m FastString Source #

Ord FastString # 
Instance details

Defined in GHC.Data.FastString

Show FastString # 
Instance details

Defined in GHC.Data.FastString

IsString FastString # 
Instance details

Defined in GHC.Data.FastString

Semigroup FastString # 
Instance details

Defined in GHC.Data.FastString

Monoid FastString # 
Instance details

Defined in GHC.Data.FastString

NFData FastString # 
Instance details

Defined in GHC.Data.FastString

Methods

rnf :: FastString -> () Source #

Outputable FastString # 
Instance details

Defined in GHC.Utils.Outputable

Uniquable FastString # 
Instance details

Defined in GHC.Types.Unique

Binary FastString # 
Instance details

Defined in GHC.Utils.Binary

Construction

mkFastString :: String -> FastString Source #

Creates a UTF-8 encoded FastString from a String

mkFastStringByteList :: [Word8] -> FastString Source #

Creates a FastString from a UTF-8 encoded [Word8]

Deconstruction

unpackFS :: FastString -> String Source #

Unpacks and decodes the FastString

Encoding

zEncodeFS :: FastString -> FastZString Source #

Returns a Z-encoded version of a FastString. This might be the original, if it was already Z-encoded. The first time this function is applied to a particular FastString, the results are memoized.

Operations

lengthFS :: FastString -> Int Source #

Returns the length of the FastString in characters

nullFS :: FastString -> Bool Source #

Returns True if the FastString is empty

Outputting

hPutFS :: Handle -> FastString -> IO () Source #

Outputs a FastString with no decoding at all, that is, you get the actual bytes in the FastString written to the Handle.

Internal

PtrStrings

data PtrString Source #

A PtrString is a pointer to some array of Latin-1 encoded chars.

Constructors

PtrString !(Ptr Word8) !Int 

Construction

mkPtrString# :: Addr# -> PtrString Source #

Wrap an unboxed address into a PtrString.

mkPtrString :: String -> PtrString Source #

Encode a String into a newly allocated PtrString using Latin-1 encoding. The original string must not contain non-Latin-1 characters (above codepoint 0xff).

Deconstruction

unpackPtrString :: PtrString -> String Source #

Decode a PtrString back into a String using Latin-1 encoding. This does not free the memory associated with PtrString.

Operations

lengthPS :: PtrString -> Int Source #

Return the length of a PtrString