Haskus.Binary.Endianness

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.

Documentation

data Endianness

Endianness

Constructors

LittleEndian

Less significant bytes first

BigEndian

Most significant bytes first

Instances

Enum Endianness

Defined in Haskus.Binary.Endianness

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

Defined in Haskus.Binary.Endianness

Methods

(==) :: Endianness -> Endianness -> Bool

(/=) :: Endianness -> Endianness -> Bool

Show Endianness

Defined in Haskus.Binary.Endianness

Methods

showsPrec :: Int -> Endianness -> ShowS

show :: Endianness -> String

showList :: [Endianness] -> ShowS

CEnum Endianness

Defined in Haskus.Binary.Endianness

Methods

fromCEnum :: Integral b => Endianness -> b

toCEnum :: Integral b => b -> Endianness

data WordGetters

Word getter

Constructors

WordGetters

Fields

• wordGetter8 :: Get Word8

  Read a Word8

• wordGetter16 :: Get Word16

  Read a Word16

• wordGetter32 :: Get Word32

  Read a Word32

• wordGetter64 :: Get Word64

  Read a Word64

data WordPutters

Word putters

Constructors

WordPutters

Fields

• wordPutter8 :: Word8 -> Put

  Write a Word8

• wordPutter16 :: Word16 -> Put

  Write a Word16

• wordPutter32 :: Word32 -> Put

  Write a Word32

• wordPutter64 :: Word64 -> Put

  Write a Word64

getWordGetters :: Endianness -> WordGetters

Get getters for the given endianness

getWordPutters :: Endianness -> WordPutters

Get putters for the given endianness

data WordSize

Size of a machine word

Constructors

WordSize32

32-bit

WordSize64

64-bit

Instances

Eq WordSize

Defined in Haskus.Binary.Endianness

Methods

(==) :: WordSize -> WordSize -> Bool

(/=) :: WordSize -> WordSize -> Bool

Show WordSize

Defined in Haskus.Binary.Endianness

Methods

showsPrec :: Int -> WordSize -> ShowS

show :: WordSize -> String

showList :: [WordSize] -> ShowS

data ExtendedWordGetters

Extended word getters

Constructors

ExtendedWordGetters

Fields

• extwordGetter8 :: Get Word8

  Read a Word8

• extwordGetter16 :: Get Word16

  Read a Word16

• extwordGetter32 :: Get Word32

  Read a Word32

• extwordGetter64 :: Get Word64

  Read a Word64

• extwordGetterN :: Get Word64

  Read a native size word into a Word64

data ExtendedWordPutters

Extended word putters

Constructors

ExtendedWordPutters

Fields

• extwordPutter8 :: Word8 -> Put

  Write a Word8

• extwordPutter16 :: Word16 -> Put

  Write a Word16

• extwordPutter32 :: Word32 -> Put

  Write a Word32

• extwordPutter64 :: Word64 -> Put

  Write a Word64

• extwordPutterN :: Word64 -> Put

  Write a Word64 into a native size word

getExtendedWordGetters :: Endianness -> WordSize -> ExtendedWordGetters

Return extended getters

getExtendedWordPutters :: Endianness -> WordSize -> ExtendedWordPutters

Return extended putters

getHostEndianness :: IO Endianness

Detect the endianness of the host memory

hostEndianness :: Endianness

Detected host endianness

TODO: use targetByteOrder in GHC.ByteOrder (should be introduced in GHC 8.4)

class ByteReversable w where

Reverse bytes in a word

Minimal complete definition

reverseBytes

Methods

reverseBytes :: w -> w

hostToBigEndian :: w -> w

bigEndianToHost :: w -> w

hostToLittleEndian :: w -> w

littleEndianToHost :: w -> w

Instances

ByteReversable Word8

Defined in Haskus.Binary.Endianness

Methods

reverseBytes :: Word8 -> Word8

hostToBigEndian :: Word8 -> Word8

bigEndianToHost :: Word8 -> Word8

hostToLittleEndian :: Word8 -> Word8

littleEndianToHost :: Word8 -> Word8

ByteReversable Word16

Defined in Haskus.Binary.Endianness

Methods

reverseBytes :: Word16 -> Word16

hostToBigEndian :: Word16 -> Word16

bigEndianToHost :: Word16 -> Word16

hostToLittleEndian :: Word16 -> Word16

littleEndianToHost :: Word16 -> Word16

ByteReversable Word32

Defined in Haskus.Binary.Endianness

Methods

reverseBytes :: Word32 -> Word32

hostToBigEndian :: Word32 -> Word32

bigEndianToHost :: Word32 -> Word32

hostToLittleEndian :: Word32 -> Word32

littleEndianToHost :: Word32 -> Word32

ByteReversable Word64

Defined in Haskus.Binary.Endianness

Methods

reverseBytes :: Word64 -> Word64

hostToBigEndian :: Word64 -> Word64

bigEndianToHost :: Word64 -> Word64

hostToLittleEndian :: Word64 -> Word64

littleEndianToHost :: Word64 -> Word64

newtype AsBigEndian a

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

Constructors

AsBigEndian a

Instances

Enum a => Enum (AsBigEndian a)

Defined in Haskus.Binary.Endianness

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)

Defined in Haskus.Binary.Endianness

Methods

(==) :: AsBigEndian a -> AsBigEndian a -> Bool

(/=) :: AsBigEndian a -> AsBigEndian a -> Bool

Integral a => Integral (AsBigEndian a)

Defined in Haskus.Binary.Endianness

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)

Defined in Haskus.Binary.Endianness

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)

Defined in Haskus.Binary.Endianness

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)

Defined in Haskus.Binary.Endianness

Methods

toRational :: AsBigEndian a -> Rational

Show a => Show (AsBigEndian a)

Defined in Haskus.Binary.Endianness

Methods

showsPrec :: Int -> AsBigEndian a -> ShowS

show :: AsBigEndian a -> String

showList :: [AsBigEndian a] -> ShowS

(ByteReversable a, Storable a) => Storable (AsBigEndian a)

Defined in Haskus.Binary.Endianness

Methods

peekIO :: Ptr (AsBigEndian a) -> IO (AsBigEndian a)

pokeIO :: Ptr (AsBigEndian a) -> AsBigEndian a -> IO ()

alignment :: AsBigEndian a -> Word

sizeOf :: AsBigEndian a -> Word

(ByteReversable a, StaticStorable a) => StaticStorable (AsBigEndian a)

Defined in Haskus.Binary.Endianness

Associated Types

type SizeOf (AsBigEndian a) :: Nat

type Alignment (AsBigEndian a) :: Nat

Methods

staticPeekIO :: Ptr (AsBigEndian a) -> IO (AsBigEndian a)

staticPokeIO :: Ptr (AsBigEndian a) -> AsBigEndian a -> IO ()

ShiftableBits a => ShiftableBits (AsBigEndian a)

Defined in Haskus.Binary.Endianness

Methods

shiftR :: AsBigEndian a -> Word -> AsBigEndian a

shiftL :: AsBigEndian a -> Word -> AsBigEndian a

uncheckedShiftR :: AsBigEndian a -> Word -> AsBigEndian a

uncheckedShiftL :: AsBigEndian a -> Word -> AsBigEndian a

shift :: AsBigEndian a -> Int -> AsBigEndian a

uncheckedShift :: AsBigEndian a -> Int -> AsBigEndian a

FiniteBits a => FiniteBits (AsBigEndian a)

Defined in Haskus.Binary.Endianness

Associated Types

type BitSize (AsBigEndian a) :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize (AsBigEndian a))) => AsBigEndian a -> i

zeroBits :: AsBigEndian a

oneBits :: AsBigEndian a

countLeadingZeros :: AsBigEndian a -> Word

countTrailingZeros :: AsBigEndian a -> Word

complement :: AsBigEndian a -> AsBigEndian a

Bitwise a => Bitwise (AsBigEndian a)

Defined in Haskus.Binary.Endianness

Methods

(.&.) :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a

(.|.) :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a

xor :: AsBigEndian a -> AsBigEndian a -> AsBigEndian a

RotatableBits a => RotatableBits (AsBigEndian a)

Defined in Haskus.Binary.Endianness

Methods

rotate :: AsBigEndian a -> Int -> AsBigEndian a

rotateL :: AsBigEndian a -> Word -> AsBigEndian a

rotateR :: AsBigEndian a -> Word -> AsBigEndian a

uncheckedRotate :: AsBigEndian a -> Int -> AsBigEndian a

uncheckedRotateL :: AsBigEndian a -> Word -> AsBigEndian a

uncheckedRotateR :: AsBigEndian a -> Word -> AsBigEndian a

IndexableBits a => IndexableBits (AsBigEndian a)

Defined in Haskus.Binary.Endianness

Methods

bit :: Word -> AsBigEndian a

setBit :: AsBigEndian a -> Word -> AsBigEndian a

clearBit :: AsBigEndian a -> Word -> AsBigEndian a

complementBit :: AsBigEndian a -> Word -> AsBigEndian a

testBit :: AsBigEndian a -> Word -> Bool

popCount :: AsBigEndian a -> Word

ReversableBits a => ReversableBits (AsBigEndian a)

Defined in Haskus.Binary.Endianness

Methods

reverseBits :: AsBigEndian a -> AsBigEndian a

Serializable a => Serializable (AsBigEndian a)

Defined in Haskus.Binary.Serialize

Associated Types

type SizeOf (AsBigEndian a) :: Size

type Endian (AsBigEndian a) :: Bool

Methods

sizeOf :: AsBigEndian a -> Word

put :: PutMonad m => Endianness -> AsBigEndian a -> m ()

get :: GetMonad m => Endianness -> m (AsBigEndian a)

type SizeOf (AsBigEndian a)

Defined in Haskus.Binary.Endianness

type SizeOf (AsBigEndian a) = SizeOf a

type Alignment (AsBigEndian a)

Defined in Haskus.Binary.Endianness

type Alignment (AsBigEndian a) = Alignment a

type BitSize (AsBigEndian a)

Defined in Haskus.Binary.Endianness

type BitSize (AsBigEndian a) = BitSize a

type SizeOf (AsBigEndian a)

Defined in Haskus.Binary.Serialize

type SizeOf (AsBigEndian a) = SizeOf a

type Endian (AsBigEndian a)

Defined in Haskus.Binary.Serialize

type Endian (AsBigEndian a) = False

newtype AsLittleEndian a

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

Constructors

AsLittleEndian a

Instances

Enum a => Enum (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

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)

Defined in Haskus.Binary.Endianness

Methods

(==) :: AsLittleEndian a -> AsLittleEndian a -> Bool

(/=) :: AsLittleEndian a -> AsLittleEndian a -> Bool

Integral a => Integral (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

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)

Defined in Haskus.Binary.Endianness

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)

Defined in Haskus.Binary.Endianness

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)

Defined in Haskus.Binary.Endianness

Methods

toRational :: AsLittleEndian a -> Rational

Show a => Show (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

Methods

showsPrec :: Int -> AsLittleEndian a -> ShowS

show :: AsLittleEndian a -> String

showList :: [AsLittleEndian a] -> ShowS

(ByteReversable a, Storable a) => Storable (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

Methods

peekIO :: Ptr (AsLittleEndian a) -> IO (AsLittleEndian a)

pokeIO :: Ptr (AsLittleEndian a) -> AsLittleEndian a -> IO ()

alignment :: AsLittleEndian a -> Word

sizeOf :: AsLittleEndian a -> Word

(ByteReversable a, StaticStorable a) => StaticStorable (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

Associated Types

type SizeOf (AsLittleEndian a) :: Nat

type Alignment (AsLittleEndian a) :: Nat

Methods

staticPeekIO :: Ptr (AsLittleEndian a) -> IO (AsLittleEndian a)

staticPokeIO :: Ptr (AsLittleEndian a) -> AsLittleEndian a -> IO ()

ShiftableBits a => ShiftableBits (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

Methods

shiftR :: AsLittleEndian a -> Word -> AsLittleEndian a

shiftL :: AsLittleEndian a -> Word -> AsLittleEndian a

uncheckedShiftR :: AsLittleEndian a -> Word -> AsLittleEndian a

uncheckedShiftL :: AsLittleEndian a -> Word -> AsLittleEndian a

shift :: AsLittleEndian a -> Int -> AsLittleEndian a

uncheckedShift :: AsLittleEndian a -> Int -> AsLittleEndian a

FiniteBits a => FiniteBits (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

Associated Types

type BitSize (AsLittleEndian a) :: Nat

Methods

bitSize :: (Integral i, KnownNat (BitSize (AsLittleEndian a))) => AsLittleEndian a -> i

zeroBits :: AsLittleEndian a

oneBits :: AsLittleEndian a

countLeadingZeros :: AsLittleEndian a -> Word

countTrailingZeros :: AsLittleEndian a -> Word

complement :: AsLittleEndian a -> AsLittleEndian a

Bitwise a => Bitwise (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

Methods

(.&.) :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a

(.|.) :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a

xor :: AsLittleEndian a -> AsLittleEndian a -> AsLittleEndian a

RotatableBits a => RotatableBits (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

Methods

rotate :: AsLittleEndian a -> Int -> AsLittleEndian a

rotateL :: AsLittleEndian a -> Word -> AsLittleEndian a

rotateR :: AsLittleEndian a -> Word -> AsLittleEndian a

uncheckedRotate :: AsLittleEndian a -> Int -> AsLittleEndian a

uncheckedRotateL :: AsLittleEndian a -> Word -> AsLittleEndian a

uncheckedRotateR :: AsLittleEndian a -> Word -> AsLittleEndian a

IndexableBits a => IndexableBits (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

Methods

bit :: Word -> AsLittleEndian a

setBit :: AsLittleEndian a -> Word -> AsLittleEndian a

clearBit :: AsLittleEndian a -> Word -> AsLittleEndian a

complementBit :: AsLittleEndian a -> Word -> AsLittleEndian a

testBit :: AsLittleEndian a -> Word -> Bool

popCount :: AsLittleEndian a -> Word

ReversableBits a => ReversableBits (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

Methods

reverseBits :: AsLittleEndian a -> AsLittleEndian a

Serializable a => Serializable (AsLittleEndian a)

Defined in Haskus.Binary.Serialize

Associated Types

type SizeOf (AsLittleEndian a) :: Size

type Endian (AsLittleEndian a) :: Bool

Methods

sizeOf :: AsLittleEndian a -> Word

put :: PutMonad m => Endianness -> AsLittleEndian a -> m ()

get :: GetMonad m => Endianness -> m (AsLittleEndian a)

type SizeOf (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

type SizeOf (AsLittleEndian a) = SizeOf a

type Alignment (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

type Alignment (AsLittleEndian a) = Alignment a

type BitSize (AsLittleEndian a)

Defined in Haskus.Binary.Endianness

type BitSize (AsLittleEndian a) = BitSize a

type SizeOf (AsLittleEndian a)

Defined in Haskus.Binary.Serialize

type SizeOf (AsLittleEndian a) = SizeOf a

type Endian (AsLittleEndian a)

Defined in Haskus.Binary.Serialize

type Endian (AsLittleEndian a) = False