Modulebase-4.20.2.0Haskell2010

GHC.Encoding.UTF8

The API of this module is unstable and not meant to be consumed by the general public. If you absolutely must depend on it, make sure to use a tight upper bound, e.g., base < 4.X rather than base < 5, because the interface can change rapidly without much warning.

Simple UTF-8 codecs supporting non-streaming encoding/decoding. For encoding where codepoints may be broken across buffers, see GHC.IO.Encoding.UTF8.

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.

10 values

Packagebase-4.20.2.0
Exports10
LanguageHaskell2010
LicenceBSD-3-Clause
SourceUTF8.hs

Decoding single characters

3 declarations

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#.

Decoding strings

2 declarations

valueutf8DecodeByteArray# :: ByteArray# -> [Char]

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

Counting characters

1 declaration

valueutf8CountCharsByteArray# :: ByteArray# -> Int

Comparison

1 declaration

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

Encoding strings

3 declarations

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

valueutf8EncodeByteArray# :: String -> ByteArray#

valueutf8EncodedLength :: String -> Int