Modulemempack-0.2.1.0Haskell2010

Data.MemPack.Buffer

1 class
9 values

Packagemempack-0.2.1.0
Exports10
LanguageHaskell2010
LicenceBSD-3-Clause
SourceBuffer.hs

classclass Buffer b where

Immutable memory buffer

Methods

bufferByteCount :: b -> Int
Number of accessible bytes in the buffer.
buffer :: b -> (ByteArray# -> Int# -> a) -> (Addr# -> a) -> a
Use one of the two suppplied functions to access memory of the buffer:
mkBuffer :: ByteArray# -> b
bufferHasToBePinned :: Bool

Instances6Buffer

Buffer ByteArrayDefined in mempack-0.2.1.0 · Data.MemPack.Buffer
Buffer ByteStringDefined in mempack-0.2.1.0 · Data.MemPack.Buffer
Buffer ShortByteStringDefined in mempack-0.2.1.0 · Data.MemPack.Buffer
Buffer (PrimArray Word8)Defined in mempack-0.2.1.0 · Data.MemPack.Buffer
Buffer (Vector Word8)Defined in mempack-0.2.1.0 · Data.MemPack.Buffer
Buffer (Vector Word8)Defined in mempack-0.2.1.0 · Data.MemPack.Buffer

valuenewMutableByteArray

:: Bool
Should the mutable array be allocated as pinned or not
-> Int
Size of the mutable array in number of bytes.
-> ST s (MutableByteArray s)

Allocate a new uninitialized MutableByteArray.

Warning - Memory allocated might contain random garbage and must be fully overwritten.

⚠ - Violation of the above rule could lead non-determinism and breakage of referential transparency.

valuefreezeMutableByteArray :: MutableByteArray d -> ST d ByteArray

O(1) - Cast a MutableByteArray to an immutable ByteArray without copy.

Warning - Source mutable array must not be mutated, after this action.

⚠ - Violation of the above rule could potentially lead to corrupt memory and segfaults.

valuewithPtrByteStringST :: ByteString -> (Ptr a -> ST s b) -> ST s b

Run ST action on the underlying Ptr that points to the beginning of the ByteString buffer. It is ok to use ByteString withing ST, as long as underlying pointer is never mutated or returned from the supplied action.

Warning - It is important for the supplied action to not produce bottom, i.e. runtime exceptions or infinite loops are not allowed within its body.

⚠ - Violation of the above rule could potentially lead to corrupt memory and segfaults.

valuewithAddrByteStringST :: ByteString -> (Addr# -> ST s b) -> ST s b

Same as withPtrByteStringST, except the supplied action expects an Addr# instead of a Ptr.

⚠ - Violation of the rule from withPtrByteStringST could potentially lead to corrupt memory and segfaults.

valuewithForeignPtrST :: ForeignPtr a -> (Addr# -> ST s b) -> ST s b

Run an ST action on the underlying Ptr that points to the beginning of the ByteString buffer. It is ok to use ByteString withing ST, as long as underlying pointer is never mutated or returned from the supplied action.

Warning - It is important for the memory that backs the underlying ForeignPtr to not be mutated outside of the ST monad that this action operates in, which is only allowed if it was allocated in this execution of the ST monad.
Warning - It is important for the memory that backs the underlying ForeignPtr to not be mutated at all if ForeignPtr was not allocated within the ST monad that this action operates in.
Warning - It is important for the supplied action to not produce bottom, i.e. runtime exceptions or infinite loops are not allowed within its body.

⚠ - Violation of the above rules could potentially lead to corrupt memory and segfaults.

valuepinnedByteArrayToByteString :: ByteArray -> ByteString

O(1) - Convert a pinned ByteArray to ByteString.

Warning - There is no check that source ByteArray was allocated as pinned, so user of this function must guarantee this invariant.

⚠ - Violation of the above rules could potentially lead to corrupt memory and segfaults.

valuepinnedByteArrayToForeignPtr :: ByteArray# -> ForeignPtr a

O(1) - Convert a pinned ByteArray# to ForeignPtr.

Warning - There is no check that source ByteArray# was allocated as pinned, so user of this function must guarantee this invariant.

⚠ - Violation of the above rules could potentially lead to corrupt memory and segfaults.

valuebyteArrayToShortByteString :: ByteArray -> ShortByteString

O(1) - Convert ByteArray to ShortByteString

valuebyteArrayFromShortByteString :: ShortByteString -> ByteArray

O(1) - Inverse of byteArrayToShortByteString. Convert ShortByteString to ByteArray