primitive-0.3.1: Wrappers for primitive operations

Portabilitynon-portable
MaintainerRoman Leshchinskiy <rl@cse.unsw.edu.au>

Data.Primitive.ByteArray

Description

Primitive operations on ByteArrays

Synopsis

Documentation

data ByteArray Source

Byte arrays

Constructors

ByteArray ByteArray# 

data MutableByteArray s Source

Mutable byte arrays associated with a primitive state token

newByteArray :: PrimMonad m => Int -> m (MutableByteArray (PrimState m))Source

Create a new mutable byte array of the specified size.

newPinnedByteArray :: PrimMonad m => Int -> m (MutableByteArray (PrimState m))Source

Create a pinned byte array of the specified size. The garbage collector is guaranteed not to move it.

newAlignedPinnedByteArray :: PrimMonad m => Int -> Int -> m (MutableByteArray (PrimState m))Source

Create a pinned byte array of the specified size and with the give alignment. The garbage collector is guaranteed not to move it.

readByteArray :: (Prim a, PrimMonad m) => MutableByteArray (PrimState m) -> Int -> m aSource

Read a primitive value from the byte array. The offset is given in elements of type a rather than in bytes.

writeByteArray :: (Prim a, PrimMonad m) => MutableByteArray (PrimState m) -> Int -> a -> m ()Source

Write a primitive value to the byte array. The offset is given in elements of type a rather than in bytes.

indexByteArray :: Prim a => ByteArray -> Int -> aSource

Read a primitive value from the byte array. The offset is given in elements of type a rather than in bytes.

unsafeFreezeByteArray :: PrimMonad m => MutableByteArray (PrimState m) -> m ByteArraySource

Convert a mutable byte array to an immutable one without copying. The array should not be modified after the conversion.

unsafeThawByteArray :: PrimMonad m => ByteArray -> m (MutableByteArray (PrimState m))Source

Convert an immutable byte array to a mutable one without copying. The original array should not be used after the conversion.

sizeofByteArray :: ByteArray -> IntSource

Size of the byte array.

sizeofMutableByteArray :: MutableByteArray s -> IntSource

Size of the mutable byte array.

sameMutableByteArray :: MutableByteArray s -> MutableByteArray s -> BoolSource

Check if the two arrays refer to the same memory block.

byteArrayContents :: ByteArray -> AddrSource

Yield a pointer to the array's data. This operation is only safe on pinned byte arrays allocated by newPinnedByteArray or newAlignedPinnedByteArray.

mutableByteArrayContents :: MutableByteArray s -> AddrSource

Yield a pointer to the array's data. This operation is only safe on pinned byte arrays allocated by newPinnedByteArray or newAlignedPinnedByteArray.