Foreign.C

Haskell type representing the C size_t type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C int type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C ptrdiff_t type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C long long type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C unsigned long long type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

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

Haskell type representing the C char type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C unsigned int type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

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

Haskell type representing the C bool type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C clock_t type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C double type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C FILE type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C float type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C fpos_t type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C jmp_buf type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C long type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C signed char type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C suseconds_t type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C short type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C sig_atomic_t type. (The concrete types of Foreign.C.Types#platform are platform-specific.) See Note [Lack of signals on wasm32-wasi].

Haskell type representing the C time_t type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C unsigned char type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C unsigned long type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C useconds_t type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C unsigned short type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

Haskell type representing the C wchar_t type. (The concrete types of Foreign.C.Types#platform are platform-specific.)

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.

as throwErrnoIf, but discards the result of the IO action after error handling.

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.

Marshal a NUL terminated C string into a Haskell string.

as throwErrnoIfMinus1, but exceptions include the given path when appropriate.

Haskell representation for errno values. The implementation is deliberately exposed, to allow users to add their own definitions of Errno values.

Construct an IOError based on the given Errno value. The optional information can be used to improve the accuracy of error messages.

Get the current value of errno in the current thread.

On GHC, the runtime will ensure that any Haskell thread will only see "its own" errno, by saving and restoring the value when Haskell threads are scheduled across OS threads.

Throw an IOError corresponding to the current value of getErrno if the IO action returns a result of -1, but retries in case of an interrupted operation.

as throwErrnoIfMinus1, but discards the result.

as throwErrnoIfMinus1, but discards the result.

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.

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

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.

Yield True if the given Errno value is valid on the system. This implies that the Eq instance of Errno is also system dependent as it is only defined for valid values of Errno.

Reset the current thread's errno value to eOK.

Throw an IOError corresponding to the current value of getErrno.

Throw an IOError corresponding to the current value of getErrno if the result value of the IO action meets the given predicate.

Throw an IOError corresponding to the current value of getErrno if the IO action returns a result of -1.

as throwErrnoIfMinus1Retry, but checks for operations that would block.

as throwErrnoIfMinus1RetryMayBlock, but discards the result.

Throw an IOError corresponding to the current value of getErrno if the IO action returns nullPtr.

Throw an IOError corresponding to the current value of getErrno if the IO action returns nullPtr, but retry in case of an interrupted operation.

as throwErrnoIfNullRetry, but checks for operations that would block.

as throwErrnoIf, but retry the IO action when it yields the error code eINTR - this amounts to the standard retry loop for interrupted POSIX system calls.

as throwErrnoIfRetry, but additionally if the operation yields the error code eAGAIN or eWOULDBLOCK, an alternative action is executed before retrying.

as throwErrnoIfRetryMayBlock, but discards the result.

as throwErrnoIfRetry, but discards the result.

as throwErrno, but exceptions include the given path when appropriate.

as throwErrnoIf, but exceptions include the given path when appropriate.

as throwErrnoIfMinus1_, but exceptions include the given path when appropriate.

as throwErrnoIfNull, but exceptions include the given path when appropriate.

as throwErrnoIf_, but exceptions include the given path when appropriate.

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.

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

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

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

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

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

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

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.

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.

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.

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.

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.

Marshal a NUL terminated C string into a Haskell string.

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

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

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

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.

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.

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

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