Data.Bitstream.Packet

For internal use only.

Documentation

data Left

Left bitstreams interpret an octet as a vector of bits whose LSB comes first and MSB comes last e.g.

• 11110000 => [False, False, False, False, True, True , True , True]
• 10010100 => [False, False, True , False, True, False, False, True]

Bits operations (like toBits) treat a Left bitstream as a little-endian integer.

Instances

Ord (Packet Left)

Show (Packet Left)

Bitstream (Packet Left)

Bitstream (Bitstream Left)

Bitstream (Bitstream Left)

data Right

Right bitstreams interpret an octet as a vector of bits whose MSB comes first and LSB comes last e.g.

• 11110000 => [True, True , True , True, False, False, False, False]
• 10010100 => [True, False, False, True, False, True , False, False]

Bits operations (like toBits) treat a Right bitstream as a big-endian integer.

Instances

Ord (Packet Right)

Show (Packet Right)

Bitstream (Packet Right)

Bitstream (Bitstream Right)

Bitstream (Bitstream Right)

data Packet d

Packets are strict Bitstreams having at most 8 bits.

Instances

Eq (Packet d)

Ord (Packet Right)

Ord (Packet Left)

Show (Packet Right)

Show (Packet Left)

Storable (Packet d)

Bitstream (Packet Right)

Bitstream (Packet Left)

full :: Packet d -> Bool

O(1) full p == True iff length p == 8, otherwise it returns False.

fromOctet :: Word8 -> Packet d

O(1) Convert an octet to Packet.

toOctet :: Packet d -> Word8

O(1) toOctet p converts a Packet p to an octet, padding with zeroes if length p < 8.

packetLToR :: Packet Left -> Packet Right

O(1) Change the direction of Packet from Left to Right. Bit directions only affect octet-based operations such as toOctet.

packetRToL :: Packet Right -> Packet Left

O(1) Change the direction of Packet from Right to Left. Bit directions only affect octet-based operations such as toOctet.