Foreign.C.String · rerebase-1.21.2

typetype CString = Ptr CChar

A C string is a reference to an array of C characters terminated by NUL.

typetype CStringLen = (Ptr CChar, Int)

A string with explicit length information in bytes instead of a terminating NUL (allowing NUL characters in the middle of the string).

valuewithCString :: String -> (CString -> IO a) -> IO a

#

Marshal a Haskell string into a NUL terminated C string using temporary storage.

the Haskell string may not contain any NUL characters
the memory is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this.

valuenewCString :: String -> IO CString

#

Marshal a Haskell string into a NUL terminated C string.

the Haskell string may not contain any NUL characters
new storage is allocated for the C string and must be explicitly freed using free or finalizerFree.

valuepeekCString :: CString -> IO String

#

Marshal a NUL terminated C string into a Haskell string.

valuewithCAStringLen :: String -> (CStringLen -> IO a) -> IO a

#

Marshal a Haskell string into a C string (ie, character array) in temporary storage, with explicit length information.

the memory is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this.

valuepeekCStringLen :: CStringLen -> IO String

#

Marshal a C string with explicit length into a Haskell string.

valuewithCAString :: String -> (CString -> IO a) -> IO a

#

Marshal a Haskell string into a NUL terminated C string using temporary storage.

the Haskell string may not contain any NUL characters
the memory is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this.

valuewithCStringLen :: String -> (CStringLen -> IO a) -> IO a

#

Marshal a Haskell string into a C string (ie, character array) in temporary storage, with explicit length information.

the memory is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this.

valuecastCCharToChar :: CChar -> Char

#

Convert a C byte, representing a Latin-1 character, to the corresponding Haskell character.

valuecastCSCharToChar :: CSChar -> Char

#

Convert a C signed char, representing a Latin-1 character, to the corresponding Haskell character.

valuecastCUCharToChar :: CUChar -> Char

#

Convert a C unsigned char, representing a Latin-1 character, to the corresponding Haskell character.

valuecastCharToCChar :: Char -> CChar

#

Convert a Haskell character to a C character. This function is only safe on the first 256 characters.

valuecastCharToCSChar :: Char -> CSChar

#

Convert a Haskell character to a C signed char. This function is only safe on the first 256 characters.

valuecastCharToCUChar :: Char -> CUChar

#

Convert a Haskell character to a C unsigned char. This function is only safe on the first 256 characters.

valuecharIsRepresentable :: Char -> IO Bool

#

valuenewCAString :: String -> IO CString

#

Marshal a Haskell string into a NUL terminated C string.

the Haskell string may not contain any NUL characters
new storage is allocated for the C string and must be explicitly freed using free or finalizerFree.

valuenewCAStringLen :: String -> IO CStringLen

#

Marshal a Haskell string into a C string (ie, character array) with explicit length information.

new storage is allocated for the C string and must be explicitly freed using free or finalizerFree.

valuenewCStringLen :: String -> IO CStringLen

#

Marshal a Haskell string into a C string (ie, character array) with explicit length information.

new storage is allocated for the C string and must be explicitly freed using free or finalizerFree.

valuenewCWString :: String -> IO CWString

#

Marshal a Haskell string into a NUL terminated C wide string.

the Haskell string may not contain any NUL characters
new storage is allocated for the C wide string and must be explicitly freed using free or finalizerFree.

valuenewCWStringLen :: String -> IO CWStringLen

#

Marshal a Haskell string into a C wide string (ie, wide character array) with explicit length information.

new storage is allocated for the C wide string and must be explicitly freed using free or finalizerFree.

valuepeekCAString :: CString -> IO String

#

Marshal a NUL terminated C string into a Haskell string.

valuepeekCAStringLen :: CStringLen -> IO String

#

Marshal a C string with explicit length into a Haskell string.

valuepeekCWString :: CWString -> IO String

#

Marshal a NUL terminated C wide string into a Haskell string.

valuepeekCWStringLen :: CWStringLen -> IO String

#

Marshal a C wide string with explicit length into a Haskell string.

valuewithCWString :: String -> (CWString -> IO a) -> IO a

#

Marshal a Haskell string into a NUL terminated C wide string using temporary storage.

the Haskell string may not contain any NUL characters
the memory is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this.

valuewithCWStringLen :: String -> (CWStringLen -> IO a) -> IO a

#

Marshal a Haskell string into a C wide string (i.e. wide character array) in temporary storage, with explicit length information.

the memory is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this.

typetype CWString = Ptr CWchar

#

A C wide string is a reference to an array of C wide characters terminated by NUL.

typetype CWStringLen = (Ptr CWchar, Int)

#

A wide character string with explicit length information in CWchars instead of a terminating NUL (allowing NUL characters in the middle of the string).