Copyright	(c) Duncan Coutts 2015-2017
License	BSD3-style (see LICENSE.txt)
Maintainer	[email protected]
Stability	experimental
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Codec.CBOR.Magic

Contents

Word utilities
ByteString utilities
Half-floats
Float/Word conversion
Int and Word explicit conversions
Integer utilities
Simple mutable counters
Array support

Description

An internal module for doing magical, low-level, and unholy things in the name of efficiency.

Synopsis

grabWord8 :: Ptr () -> Word8
grabWord16 :: Ptr () -> Word16
grabWord32 :: Ptr () -> Word32
grabWord64 :: Ptr () -> Word64
eatTailWord8 :: ByteString -> Word8
eatTailWord16 :: ByteString -> Word16
eatTailWord32 :: ByteString -> Word32
eatTailWord64 :: ByteString -> Word64
wordToFloat16 :: Word16 -> Float
floatToWord16 :: Float -> Word16
wordToFloat32 :: Word32 -> Float
wordToFloat64 :: Word64 -> Double
word8ToWord :: Word8 -> Word
word16ToWord :: Word16 -> Word
word32ToWord :: Word32 -> Word
word64ToWord :: Word64 -> Word
word8ToInt :: Word8 -> Int
word16ToInt :: Word16 -> Int
word32ToInt :: Word32 -> Int
word64ToInt :: Word64 -> Maybe Int
intToWord :: Int -> Word
intToInt64 :: Int -> Int64
intToWord64 :: Int -> Word64
int64ToWord64 :: Int64 -> Word64
nintegerFromBytes :: ByteString -> Integer
uintegerFromBytes :: ByteString -> Integer
data Counter s
newCounter :: Int -> ST s (Counter s)
readCounter :: Counter s -> ST s Int
writeCounter :: Counter s -> Int -> ST s ()
incCounter :: Counter s -> ST s ()
decCounter :: Counter s -> ST s ()
copyByteStringToByteArray :: ByteString -> ByteArray
copyByteArrayToByteString :: ByteArray -> Int -> Int -> ByteString

Word utilities

grabWord8 :: Ptr () -> Word8 Source #

Grab a 8-bit Word given a Ptr to some address.

grabWord16 :: Ptr () -> Word16 Source #

Grab a 16-bit Word given a Ptr to some address.

grabWord32 :: Ptr () -> Word32 Source #

Grab a 32-bit Word given a Ptr to some address.

grabWord64 :: Ptr () -> Word64 Source #

Grab a 64-bit Word64 given a Ptr to some address.

`ByteString` utilities

eatTailWord8 :: ByteString -> Word8 Source #

Take the tail of a ByteString (i.e. drop the first byte) and read the resulting byte(s) as an 8-bit word value. The input ByteString MUST be at least 2 bytes long: one byte to drop from the front, and one to read as a Word value. This is not checked, and failure to ensure this will result in undefined behavior.

eatTailWord16 :: ByteString -> Word16 Source #

Take the tail of a ByteString (i.e. drop the first byte) and read the resulting byte(s) as a 16-bit word value. The input ByteString MUST be at least 3 bytes long: one byte to drop from the front, and two to read as a 16-bit Word value. This is not checked, and failure to ensure this will result in undefined behavior.

eatTailWord32 :: ByteString -> Word32 Source #

Take the tail of a ByteString (i.e. drop the first byte) and read the resulting byte(s) as a 32-bit word value. The input ByteString MUST be at least 5 bytes long: one byte to drop from the front, and four to read as a 32-bit Word value. This is not checked, and failure to ensure this will result in undefined behavior.

eatTailWord64 :: ByteString -> Word64 Source #

Take the tail of a ByteString (i.e. drop the first byte) and read the resulting byte(s) as a 64-bit word value. The input ByteString MUST be at least 9 bytes long: one byte to drop from the front, and eight to read as a 64-bit Word64 value. This is not checked, and failure to ensure this will result in undefined behavior.