HsForeign.Primitive

Documentation

newtype BA# a

Constructors

BA# ByteArray#

newtype MBA# a

Constructors

MBA# (MutableByteArray# RealWorld)

newtype BAArray# a

Constructors

BAArray# ArrayArray#

withPrim :: forall a b. Prim a => a -> (Ptr a -> IO b) -> IO (a, b)

Create an one element primitive array and use it as a pointer to the primitive element.

Don't pass a forever loop to this function, see #14346.

allocPrim :: forall a b. Prim a => (Ptr a -> IO b) -> IO (a, b)

like withPrim, but don't write initial value.

withPrimUnsafe :: Prim a => a -> (MBA# a -> IO b) -> IO (a, b)

Create an one element primitive array and use it as a pointer to the primitive element.

Return the element and the computation result.

USE THIS FUNCTION WITH UNSAFE SYNC FFI CALL ONLY.

allocPrimUnsafe :: Prim a => (MBA# a -> IO b) -> IO (a, b)

like withPrimUnsafe, but don't write initial value.

USE THIS FUNCTION WITH UNSAFE SYNC FFI CALL ONLY.

withPrimArray :: Prim a => PrimArray a -> (Ptr a -> Int -> IO b) -> IO b

Pass primitive array to safe FFI as pointer.

Use proper pointer type and HsInt to marshall Ptr a and Int arguments on C side. The memory pointed by 'Ptr a' will not moved during call. After call returned, pointer is no longer valid.

The second Int arguement is the element size not the bytes size.

Don't pass a forever loop to this function, see #14346.

withPrimList :: Prim a => [a] -> (Ptr a -> Int -> IO b) -> IO b

allocPrimArray

Arguments

:: forall a b. Prim a

=> Int

in elements

-> (Ptr a -> IO b)

-> IO (PrimArray a, b)

Allocate a prim array and pass to FFI as pointer, freeze result into a PrimVector.

withPrimArrayUnsafe :: Prim a => PrimArray a -> (BA# a -> Int -> IO b) -> IO b

Pass primitive array to unsafe FFI as pointer.

Enable UnliftedFFITypes extension in your haskell code, use proper pointer type and HsInt to marshall ByteArray# and Int arguments on C side.

The second Int arguement is the element size not the bytes size.

USE THIS FUNCTION WITH UNSAFE SYNC FFI CALL ONLY.

allocPrimArrayUnsafe :: forall a b. Prim a => Int -> (MBA# a -> IO b) -> IO (PrimArray a, b)

Allocate some bytes and pass to FFI as pointer, freeze result into a PrimArray.

USE THIS FUNCTION WITH UNSAFE SYNC FFI CALL ONLY.

withPrimArrayList :: Prim a => [PrimArray a] -> (Ptr (Ptr a) -> Int -> IO b) -> IO b

Pass primitive array list to safe FFI as pointer.

Use proper pointer type and HsInt to marshall Ptr (Ptr a) and Int arguments on C side. The memory pointed by 'Ptr a' will not moved during call. After call returned, pointer is no longer valid.

The second Int arguement is the list size.

Don't pass a forever loop to this function, see #14346.

withPrimArrayListUnsafe :: [PrimArray a] -> (BAArray# a -> Int -> IO b) -> IO b

Pass primitive array list to unsafe FFI as StgArrBytes**.

Enable UnliftedFFITypes extension in your haskell code, use StgArrBytes**(>=8.10) or StgMutArrPtrs*(<8.10) pointer type and HsInt to marshall BAArray# and Int arguments on C side.

The second Int arguement is the list size.

USE THIS FUNCTION WITH UNSAFE FFI CALL ONLY.

withForeignPtrList :: [ForeignPtr a] -> (Ptr (Ptr a) -> Int -> IO b) -> IO b

Internal helpers

withMutablePrimArrayContents :: MutablePrimArray RealWorld a -> (Ptr a -> IO b) -> IO b

Obtain the pointer to the content of an mutable array, and the pointer should only be used during the IO action.

This operation is only safe on pinned primitive arrays (Arrays allocated by newPinnedPrimArray or newAlignedPinnedPrimArray).

Don't pass a forever loop to this function, see #14346.

withPrimArrayContents :: PrimArray a -> (Ptr a -> IO b) -> IO b

Obtain the pointer to the content of an array, and the pointer should only be used during the IO action.

This operation is only safe on pinned primitive arrays (Arrays allocated by newPinnedPrimArray or newAlignedPinnedPrimArray).

Don't pass a forever loop to this function, see #14346.

byteArrayContents# :: ByteArray# -> Addr#

Intended for use with pinned arrays; otherwise very unsafe!

mutableByteArrayContents# :: MutableByteArray# s -> Addr#

Re-exports

module Data.Primitive

module Control.Monad.Primitive