byte-order-0.1.2.0: Portable big-endian and little-endian conversions

Safe HaskellNone
LanguageHaskell2010

Data.Primitive.ByteArray.BigEndian

Contents

Description

This is drop-in replacement for the read, write, and index functions present in Data.Primitive.ByteArray and Data.Primitive.ByteArray.Unaligned. While the functions from those modules use native byte order, the functions in this one use big-endian byte order (most significant byte first).

Synopsis

Aligned

writeByteArray :: (PrimMonad m, Prim a, Bytes a) => 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. The most significant byte in the value comes first.

readByteArray :: (PrimMonad m, Prim a, Bytes a) => MutableByteArray (PrimState m) -> Int -> m a Source #

Read a primitive value from the byte array, interpreting the first byte as the most significant one. The offset is given in elements of type a rather than in bytes.

indexByteArray :: (Prim a, Bytes a) => ByteArray -> Int -> a Source #

Read a primitive value from the byte array, interpreting the first byte as the most significant one. The offset is given in elements of type a rather than in bytes.

Unaligned

writeUnalignedByteArray :: (PrimMonad m, PrimUnaligned a, Bytes a) => MutableByteArray (PrimState m) -> Int -> a -> m () Source #

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

readUnalignedByteArray :: (PrimMonad m, PrimUnaligned a, Bytes a) => MutableByteArray (PrimState m) -> Int -> m a Source #

Read a primitive value from the byte array, interpreting the first byte as the most significant one. The offset is given in bytes rather than in elements of type a.

indexUnalignedByteArray :: (PrimUnaligned a, Bytes a) => ByteArray -> Int -> a Source #

Read a primitive value from the byte array, interpreting the first byte as the most significant one. The offset is given in bytes rather than in elements of type a.