Safe Haskell	None
Language	Haskell2010

Haskus.Format.Binary.Endianness

Description

Byte order ("endianness")

Indicate in which order bytes are stored in memory for multi-bytes types. Big-endian means that most-significant bytes come first. Little-endian means that least-significant bytes come first.

Synopsis

Documentation

data Endianness Source #

Endianness

Constructors

LittleEndian	Less significant bytes first
BigEndian	Most significant bytes first

Instances

Enum Endianness Source #
Methods succ :: Endianness -> Endianness # pred :: Endianness -> Endianness # toEnum :: Int -> Endianness # fromEnum :: Endianness -> Int # enumFrom :: Endianness -> [Endianness] # enumFromThen :: Endianness -> Endianness -> [Endianness] # enumFromTo :: Endianness -> Endianness -> [Endianness] # enumFromThenTo :: Endianness -> Endianness -> Endianness -> [Endianness] #
Eq Endianness Source #
Methods (==) :: Endianness -> Endianness -> Bool # (/=) :: Endianness -> Endianness -> Bool #
Show Endianness Source #
Methods showsPrec :: Int -> Endianness -> ShowS # show :: Endianness -> String # showList :: [Endianness] -> ShowS #
CEnum Endianness Source #
Methods fromCEnum :: Integral b => Endianness -> b Source # toCEnum :: Integral b => b -> Endianness Source #

data WordGetters Source #

Word getter

Constructors

WordGetters
Fields wordGetter8 :: Get Word8 Read a Word8 wordGetter16 :: Get Word16 Read a Word16 wordGetter32 :: Get Word32 Read a Word132 wordGetter64 :: Get Word64 Read a Word64

data WordPutters Source #

Word putters

Constructors

WordPutters
Fields wordPutter8 :: Word8 -> Put Write a Word8 wordPutter16 :: Word16 -> Put Write a Word16 wordPutter32 :: Word32 -> Put Write a Word132 wordPutter64 :: Word64 -> Put Write a Word64

getWordGetters :: Endianness -> WordGetters Source #

Get getters for the given endianness

getWordPutters :: Endianness -> WordPutters Source #

Get putters for the given endianness

data WordSize Source #

Size of a machine word

Constructors

WordSize32	32-bit
WordSize64	64-bit

Instances

Eq WordSize Source #
Methods (==) :: WordSize -> WordSize -> Bool # (/=) :: WordSize -> WordSize -> Bool #
Show WordSize Source #
Methods showsPrec :: Int -> WordSize -> ShowS # show :: WordSize -> String # showList :: [WordSize] -> ShowS #

data ExtendedWordGetters Source #

Extended word getters

Constructors

ExtendedWordGetters
Fields extwordGetter8 :: Get Word8 Read a Word8 extwordGetter16 :: Get Word16 Read a Word16 extwordGetter32 :: Get Word32 Read a Word132 extwordGetter64 :: Get Word64 Read a Word64 extwordGetterN :: Get Word64 Read a native size word into a Word64

data ExtendedWordPutters Source #

Extended word putters

Constructors

ExtendedWordPutters
Fields extwordPutter8 :: Word8 -> Put Write a Word8 extwordPutter16 :: Word16 -> Put Write a Word16 extwordPutter32 :: Word32 -> Put Write a Word132 extwordPutter64 :: Word64 -> Put Write a Word64 extwordPutterN :: Word64 -> Put Write a Word64 into a native size word

getExtendedWordGetters :: Endianness -> WordSize -> ExtendedWordGetters Source #

Return extended getters

getExtendedWordPutters :: Endianness -> WordSize -> ExtendedWordPutters Source #

Return extended putters

getHostEndianness :: IO Endianness Source #

Detect the endianness of the host memory

hostEndianness :: Endianness Source #

Detected host endianness

class ByteReversable w where Source #

Reverse bytes in a word

Minimal complete definition

reverseBytes

Methods

reverseBytes :: w -> w Source #

hostToBigEndian :: w -> w Source #

bigEndianToHost :: w -> w Source #

hostToLittleEndian :: w -> w Source #

littleEndianToHost :: w -> w Source #

Instances

ByteReversable Word8 Source #
Methods reverseBytes :: Word8 -> Word8 Source # hostToBigEndian :: Word8 -> Word8 Source # bigEndianToHost :: Word8 -> Word8 Source # hostToLittleEndian :: Word8 -> Word8 Source # littleEndianToHost :: Word8 -> Word8 Source #
ByteReversable Word16 Source #
Methods reverseBytes :: Word16 -> Word16 Source # hostToBigEndian :: Word16 -> Word16 Source # bigEndianToHost :: Word16 -> Word16 Source # hostToLittleEndian :: Word16 -> Word16 Source # littleEndianToHost :: Word16 -> Word16 Source #
ByteReversable Word32 Source #
Methods reverseBytes :: Word32 -> Word32 Source # hostToBigEndian :: Word32 -> Word32 Source # bigEndianToHost :: Word32 -> Word32 Source # hostToLittleEndian :: Word32 -> Word32 Source # littleEndianToHost :: Word32 -> Word32 Source #
ByteReversable Word64 Source #
Methods reverseBytes :: Word64 -> Word64 Source # hostToBigEndian :: Word64 -> Word64 Source # bigEndianToHost :: Word64 -> Word64 Source # hostToLittleEndian :: Word64 -> Word64 Source # littleEndianToHost :: Word64 -> Word64 Source #

newtype AsBigEndian a Source #

Force a data to be read/stored as big-endian

Constructors

AsBigEndian a

Instances

Enum a => Enum (AsBigEndian a) Source #
Methods succ :: AsBigEndian a -> AsBigEndian a # pred :: AsBigEndian a -> AsBigEndian a # toEnum :: Int -> AsBigEndian a # fromEnum :: AsBigEndian a -> Int # enumFrom :: AsBigEndian a -> [AsBigEndian a] # enumFromThen :: AsBigEndian a -> AsBigEndian a -> [AsBigEndian a] # enumFromTo :: AsBigEndian a -> AsBigEndian a -> [AsBigEndian a] # enumFromThenTo :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a -> [AsBigEndian a] #
Eq a => Eq (AsBigEndian a) Source #
Methods (==) :: AsBigEndian a -> AsBigEndian a -> Bool # (/=) :: AsBigEndian a -> AsBigEndian a -> Bool #
Integral a => Integral (AsBigEndian a) Source #
Methods quot :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a # rem :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a # div :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a # mod :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a # quotRem :: AsBigEndian a -> AsBigEndian a -> (AsBigEndian a, AsBigEndian a) # divMod :: AsBigEndian a -> AsBigEndian a -> (AsBigEndian a, AsBigEndian a) # toInteger :: AsBigEndian a -> Integer #
Num a => Num (AsBigEndian a) Source #
Methods (+) :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a # (-) :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a # (*) :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a # negate :: AsBigEndian a -> AsBigEndian a # abs :: AsBigEndian a -> AsBigEndian a # signum :: AsBigEndian a -> AsBigEndian a # fromInteger :: Integer -> AsBigEndian a #
Ord a => Ord (AsBigEndian a) Source #
Methods compare :: AsBigEndian a -> AsBigEndian a -> Ordering # (<) :: AsBigEndian a -> AsBigEndian a -> Bool # (<=) :: AsBigEndian a -> AsBigEndian a -> Bool # (>) :: AsBigEndian a -> AsBigEndian a -> Bool # (>=) :: AsBigEndian a -> AsBigEndian a -> Bool # max :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a # min :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a #
Real a => Real (AsBigEndian a) Source #
Methods toRational :: AsBigEndian a -> Rational #
Show a => Show (AsBigEndian a) Source #
Methods showsPrec :: Int -> AsBigEndian a -> ShowS # show :: AsBigEndian a -> String # showList :: [AsBigEndian a] -> ShowS #
(ByteReversable a, Storable a) => Storable (AsBigEndian a) Source #
Methods peekIO :: Ptr (AsBigEndian a) -> IO (AsBigEndian a) Source # pokeIO :: Ptr (AsBigEndian a) -> AsBigEndian a -> IO () Source # alignment :: AsBigEndian a -> Word Source # sizeOf :: AsBigEndian a -> Word Source #
(ByteReversable a, StaticStorable a) => StaticStorable (AsBigEndian a) Source #
Associated Types type SizeOf (AsBigEndian a) :: Nat Source # type Alignment (AsBigEndian a) :: Nat Source # Methods staticPeekIO :: Ptr (AsBigEndian a) -> IO (AsBigEndian a) Source # staticPokeIO :: Ptr (AsBigEndian a) -> AsBigEndian a -> IO () Source #
type SizeOf (AsBigEndian a) Source #
type SizeOf (AsBigEndian a) = SizeOf a
type Alignment (AsBigEndian a) Source #
type Alignment (AsBigEndian a) = Alignment a

newtype AsLittleEndian a Source #

Force a data to be read/stored as little-endian

Constructors

AsLittleEndian a

Instances

Enum a => Enum (AsLittleEndian a) Source #
Methods succ :: AsLittleEndian a -> AsLittleEndian a # pred :: AsLittleEndian a -> AsLittleEndian a # toEnum :: Int -> AsLittleEndian a # fromEnum :: AsLittleEndian a -> Int # enumFrom :: AsLittleEndian a -> [AsLittleEndian a] # enumFromThen :: AsLittleEndian a -> AsLittleEndian a -> [AsLittleEndian a] # enumFromTo :: AsLittleEndian a -> AsLittleEndian a -> [AsLittleEndian a] # enumFromThenTo :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a -> [AsLittleEndian a] #
Eq a => Eq (AsLittleEndian a) Source #
Methods (==) :: AsLittleEndian a -> AsLittleEndian a -> Bool # (/=) :: AsLittleEndian a -> AsLittleEndian a -> Bool #
Integral a => Integral (AsLittleEndian a) Source #
Methods quot :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a # rem :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a # div :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a # mod :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a # quotRem :: AsLittleEndian a -> AsLittleEndian a -> (AsLittleEndian a, AsLittleEndian a) # divMod :: AsLittleEndian a -> AsLittleEndian a -> (AsLittleEndian a, AsLittleEndian a) # toInteger :: AsLittleEndian a -> Integer #
Num a => Num (AsLittleEndian a) Source #
Methods (+) :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a # (-) :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a # (*) :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a # negate :: AsLittleEndian a -> AsLittleEndian a # abs :: AsLittleEndian a -> AsLittleEndian a # signum :: AsLittleEndian a -> AsLittleEndian a # fromInteger :: Integer -> AsLittleEndian a #
Ord a => Ord (AsLittleEndian a) Source #
Methods compare :: AsLittleEndian a -> AsLittleEndian a -> Ordering # (<) :: AsLittleEndian a -> AsLittleEndian a -> Bool # (<=) :: AsLittleEndian a -> AsLittleEndian a -> Bool # (>) :: AsLittleEndian a -> AsLittleEndian a -> Bool # (>=) :: AsLittleEndian a -> AsLittleEndian a -> Bool # max :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a # min :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a #
Real a => Real (AsLittleEndian a) Source #
Methods toRational :: AsLittleEndian a -> Rational #
Show a => Show (AsLittleEndian a) Source #
Methods showsPrec :: Int -> AsLittleEndian a -> ShowS # show :: AsLittleEndian a -> String # showList :: [AsLittleEndian a] -> ShowS #
(ByteReversable a, Storable a) => Storable (AsLittleEndian a) Source #
Methods peekIO :: Ptr (AsLittleEndian a) -> IO (AsLittleEndian a) Source # pokeIO :: Ptr (AsLittleEndian a) -> AsLittleEndian a -> IO () Source # alignment :: AsLittleEndian a -> Word Source # sizeOf :: AsLittleEndian a -> Word Source #
(ByteReversable a, StaticStorable a) => StaticStorable (AsLittleEndian a) Source #
Associated Types type SizeOf (AsLittleEndian a) :: Nat Source # type Alignment (AsLittleEndian a) :: Nat Source # Methods staticPeekIO :: Ptr (AsLittleEndian a) -> IO (AsLittleEndian a) Source # staticPokeIO :: Ptr (AsLittleEndian a) -> AsLittleEndian a -> IO () Source #
type SizeOf (AsLittleEndian a) Source #
type SizeOf (AsLittleEndian a) = SizeOf a
type Alignment (AsLittleEndian a) Source #
type Alignment (AsLittleEndian a) = Alignment a