Moduleghc-boot-10.0.0.20260917GHC2024

GHC.Utils.Encoding.UTF8

Simple, non-streaming Modified UTF-8 codecs.

This is one of several UTF-8 implementations provided by GHC; see Note [GHC's many UTF-8 implementations] in GHC.Encoding.UTF8 for an overview.

Contents

Synopsis

Decoding single characters

valueutf8DecodeCharAddr# :: Addr# -> Int# -> (# Char#, Int# #)

Decode a single character at the given Addr#.

valueutf8DecodeCharPtr :: Ptr Word8 -> (Char, Int)

Decode a single codepoint starting at the given Ptr.

valueutf8DecodeCharByteArray# :: ByteArray# -> Int# -> (# Char#, Int# #)

Decode a single codepoint starting at the given byte offset into a ByteArray#.

valueutf8PrevChar :: Ptr Word8 -> IO (Ptr Word8)

Find the start of the codepoint preceding the codepoint at the given Ptr. This is undefined if there is no previous valid codepoint.

valueutf8CharStart :: Ptr Word8 -> IO (Ptr Word8)

Find the start of the codepoint at the given Ptr. This is undefined if there is no previous valid codepoint.

valueutf8UnconsByteString :: ByteString -> Maybe (Char, ByteString)

valueutf8DecodeByteString :: ByteString -> [Char]

Decode a ByteString containing a UTF-8 string.

valueutf8DecodeShortByteString :: ShortByteString -> [Char]

valueutf8DecodeForeignPtr :: ForeignPtr Word8 -> Int -> Int -> [Char]

valueutf8DecodeByteArray# :: ByteArray# -> [Char]

valueutf8CountCharsShortByteString :: ShortByteString -> Int

valueutf8CountCharsByteArray# :: ByteArray# -> Int

valueutf8CompareByteArray# :: ByteArray# -> ByteArray# -> Ordering

valueutf8CompareShortByteString :: ShortByteString -> ShortByteString -> Ordering

valueutf8EncodeByteArray# :: String -> ByteArray#

valueutf8EncodePtr :: Ptr Word8 -> String -> IO ()

valueutf8EncodeByteString :: String -> ByteString

Encode a String into a ByteString.

valueutf8EncodeShortByteString :: String -> ShortByteString

valueutf8EncodedLength :: String -> Int