primitive-0.3: Wrappers for primitive operations Source code Contents Index

Data.Primitive.ByteArray Portability non-portable Maintainer Roman Leshchinskiy <rl@cse.unsw.edu.au>

Description

Primitive operations on ByteArrays

Synopsis

data ByteArray = ByteArray ByteArray# data MutableByteArray s = MutableByteArray (MutableByteArray# s) ByteArray# MutableByteArray# newByteArray :: PrimMonad m => Int -> m (MutableByteArray (PrimState m)) newPinnedByteArray :: PrimMonad m => Int -> m (MutableByteArray (PrimState m)) newAlignedPinnedByteArray :: PrimMonad m => Int -> Int -> m (MutableByteArray (PrimState m)) readByteArray :: (Prim a, PrimMonad m) => MutableByteArray (PrimState m) -> Int -> m a writeByteArray :: (Prim a, PrimMonad m) => MutableByteArray (PrimState m) -> Int -> a -> m () indexByteArray :: Prim a => ByteArray -> Int -> a unsafeFreezeByteArray :: PrimMonad m => MutableByteArray (PrimState m) -> m ByteArray sizeofByteArray :: ByteArray -> Int sizeofMutableByteArray :: MutableByteArray s -> Int sameMutableByteArray :: MutableByteArray s -> MutableByteArray s -> Bool byteArrayContents :: ByteArray -> Addr memcpyByteArray :: PrimMonad m => MutableByteArray (PrimState m) -> Int -> MutableByteArray (PrimState m) -> Int -> Int -> m () memcpyByteArray' :: PrimMonad m => MutableByteArray (PrimState m) -> Int -> ByteArray -> Int -> Int -> m () memmoveByteArray :: PrimMonad m => MutableByteArray (PrimState m) -> Int -> MutableByteArray (PrimState m) -> Int -> Int -> m () memsetByteArray :: PrimMonad m => MutableByteArray (PrimState m) -> Int -> Word8 -> Int -> m ()

Documentation

data ByteArray Source

Byte arrays Constructors ByteArray ByteArray#

data MutableByteArray s Source

Mutable byte arrays associated with a primitive state token Constructors MutableByteArray (MutableByteArray# s)

ByteArray#

MutableByteArray#

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 a Source

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 -> a Source

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 ByteArray Source

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

sizeofByteArray :: ByteArray -> Int Source

Size of the byte array.

sizeofMutableByteArray :: MutableByteArray s -> Int Source

Size of the mutable byte array.

sameMutableByteArray :: MutableByteArray s -> MutableByteArray s -> Bool Source

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

byteArrayContents :: ByteArray -> Addr Source

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

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

memcpyByteArray' :: PrimMonad m => MutableByteArray (PrimState m) -> Int -> ByteArray -> Int -> Int -> m () Source

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

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

Produced by Haddock version 2.6.0