Safe Haskell	Safe-Inferred
Language	Haskell2010

Capnp.Bits

Description

This module provides misc. utilities for bitwhacking that are useful in dealing with low-level details of the Cap'N Proto wire format.

This is mostly an implementation detail; users are unlikely to need to use this module directly.

Synopsis

newtype BitCount = BitCount Int
newtype ByteCount = ByteCount Int
newtype WordCount = WordCount Int
newtype Word1 = Word1 {
- word1ToBool :: Bool
}
bitsToBytesCeil :: BitCount -> ByteCount
bytesToWordsCeil :: ByteCount -> WordCount
bytesToWordsFloor :: ByteCount -> WordCount
wordsToBytes :: WordCount -> ByteCount
lo :: Word64 -> Word32
hi :: Word64 -> Word32
i32 :: Word32 -> Int32
i30 :: Word32 -> Int32
i29 :: Word32 -> Int32
fromLo :: Word32 -> Word64
fromHi :: Word32 -> Word64
fromI32 :: Int32 -> Word32
fromI30 :: Int32 -> Word32
fromI29 :: Int32 -> Word32
bitRange :: Integral a => Word64 -> Int -> Int -> a
replaceBits :: (Bounded a, Integral a) => a -> Word64 -> Int -> Word64

Documentation

newtype BitCount Source #

Wrapper type for a quantity of bits. This along with ByteCount and WordCount are helpful for avoiding mixing up units

Constructors

BitCount Int

Instances

Instances details

Bits BitCount Source #
Instance details Defined in Capnp.Bits Methods (.&.) :: BitCount -> BitCount -> BitCount # (.\|.) :: BitCount -> BitCount -> BitCount # xor :: BitCount -> BitCount -> BitCount # complement :: BitCount -> BitCount # shift :: BitCount -> Int -> BitCount # rotate :: BitCount -> Int -> BitCount # zeroBits :: BitCount # bit :: Int -> BitCount # setBit :: BitCount -> Int -> BitCount # clearBit :: BitCount -> Int -> BitCount # complementBit :: BitCount -> Int -> BitCount # testBit :: BitCount -> Int -> Bool # bitSizeMaybe :: BitCount -> Maybe Int # bitSize :: BitCount -> Int # isSigned :: BitCount -> Bool # shiftL :: BitCount -> Int -> BitCount # unsafeShiftL :: BitCount -> Int -> BitCount # shiftR :: BitCount -> Int -> BitCount # unsafeShiftR :: BitCount -> Int -> BitCount # rotateL :: BitCount -> Int -> BitCount # rotateR :: BitCount -> Int -> BitCount # popCount :: BitCount -> Int #
Bounded BitCount Source #
Instance details Defined in Capnp.Bits Methods minBound :: BitCount # maxBound :: BitCount #
Enum BitCount Source #
Instance details Defined in Capnp.Bits Methods succ :: BitCount -> BitCount # pred :: BitCount -> BitCount # toEnum :: Int -> BitCount # fromEnum :: BitCount -> Int # enumFrom :: BitCount -> [BitCount] # enumFromThen :: BitCount -> BitCount -> [BitCount] # enumFromTo :: BitCount -> BitCount -> [BitCount] # enumFromThenTo :: BitCount -> BitCount -> BitCount -> [BitCount] #
Num BitCount Source #
Instance details Defined in Capnp.Bits Methods (+) :: BitCount -> BitCount -> BitCount # (-) :: BitCount -> BitCount -> BitCount # (*) :: BitCount -> BitCount -> BitCount # negate :: BitCount -> BitCount # abs :: BitCount -> BitCount # signum :: BitCount -> BitCount # fromInteger :: Integer -> BitCount #
Integral BitCount Source #
Instance details Defined in Capnp.Bits Methods quot :: BitCount -> BitCount -> BitCount # rem :: BitCount -> BitCount -> BitCount # div :: BitCount -> BitCount -> BitCount # mod :: BitCount -> BitCount -> BitCount # quotRem :: BitCount -> BitCount -> (BitCount, BitCount) # divMod :: BitCount -> BitCount -> (BitCount, BitCount) # toInteger :: BitCount -> Integer #
Real BitCount Source #
Instance details Defined in Capnp.Bits Methods toRational :: BitCount -> Rational #
Show BitCount Source #
Instance details Defined in Capnp.Bits Methods showsPrec :: Int -> BitCount -> ShowS # show :: BitCount -> String # showList :: [BitCount] -> ShowS #
Eq BitCount Source #
Instance details Defined in Capnp.Bits Methods (==) :: BitCount -> BitCount -> Bool # (/=) :: BitCount -> BitCount -> Bool #
Ord BitCount Source #
Instance details Defined in Capnp.Bits Methods compare :: BitCount -> BitCount -> Ordering # (<) :: BitCount -> BitCount -> Bool # (<=) :: BitCount -> BitCount -> Bool # (>) :: BitCount -> BitCount -> Bool # (>=) :: BitCount -> BitCount -> Bool # max :: BitCount -> BitCount -> BitCount # min :: BitCount -> BitCount -> BitCount #

newtype ByteCount Source #

A quantity of bytes

Constructors

ByteCount Int

Instances

Instances details

Bits ByteCount Source #
Instance details Defined in Capnp.Bits Methods (.&.) :: ByteCount -> ByteCount -> ByteCount # (.\|.) :: ByteCount -> ByteCount -> ByteCount # xor :: ByteCount -> ByteCount -> ByteCount # complement :: ByteCount -> ByteCount # shift :: ByteCount -> Int -> ByteCount # rotate :: ByteCount -> Int -> ByteCount # zeroBits :: ByteCount # bit :: Int -> ByteCount # setBit :: ByteCount -> Int -> ByteCount # clearBit :: ByteCount -> Int -> ByteCount # complementBit :: ByteCount -> Int -> ByteCount # testBit :: ByteCount -> Int -> Bool # bitSizeMaybe :: ByteCount -> Maybe Int # bitSize :: ByteCount -> Int # isSigned :: ByteCount -> Bool # shiftL :: ByteCount -> Int -> ByteCount # unsafeShiftL :: ByteCount -> Int -> ByteCount # shiftR :: ByteCount -> Int -> ByteCount # unsafeShiftR :: ByteCount -> Int -> ByteCount # rotateL :: ByteCount -> Int -> ByteCount # rotateR :: ByteCount -> Int -> ByteCount # popCount :: ByteCount -> Int #
Bounded ByteCount Source #
Instance details Defined in Capnp.Bits Methods minBound :: ByteCount # maxBound :: ByteCount #
Enum ByteCount Source #
Instance details Defined in Capnp.Bits Methods succ :: ByteCount -> ByteCount # pred :: ByteCount -> ByteCount # toEnum :: Int -> ByteCount # fromEnum :: ByteCount -> Int # enumFrom :: ByteCount -> [ByteCount] # enumFromThen :: ByteCount -> ByteCount -> [ByteCount] # enumFromTo :: ByteCount -> ByteCount -> [ByteCount] # enumFromThenTo :: ByteCount -> ByteCount -> ByteCount -> [ByteCount] #
Num ByteCount Source #
Instance details Defined in Capnp.Bits Methods (+) :: ByteCount -> ByteCount -> ByteCount # (-) :: ByteCount -> ByteCount -> ByteCount # (*) :: ByteCount -> ByteCount -> ByteCount # negate :: ByteCount -> ByteCount # abs :: ByteCount -> ByteCount # signum :: ByteCount -> ByteCount # fromInteger :: Integer -> ByteCount #
Integral ByteCount Source #
Instance details Defined in Capnp.Bits Methods quot :: ByteCount -> ByteCount -> ByteCount # rem :: ByteCount -> ByteCount -> ByteCount # div :: ByteCount -> ByteCount -> ByteCount # mod :: ByteCount -> ByteCount -> ByteCount # quotRem :: ByteCount -> ByteCount -> (ByteCount, ByteCount) # divMod :: ByteCount -> ByteCount -> (ByteCount, ByteCount) # toInteger :: ByteCount -> Integer #
Real ByteCount Source #
Instance details Defined in Capnp.Bits Methods toRational :: ByteCount -> Rational #
Show ByteCount Source #
Instance details Defined in Capnp.Bits Methods showsPrec :: Int -> ByteCount -> ShowS # show :: ByteCount -> String # showList :: [ByteCount] -> ShowS #
Eq ByteCount Source #
Instance details Defined in Capnp.Bits Methods (==) :: ByteCount -> ByteCount -> Bool # (/=) :: ByteCount -> ByteCount -> Bool #
Ord ByteCount Source #
Instance details Defined in Capnp.Bits Methods compare :: ByteCount -> ByteCount -> Ordering # (<) :: ByteCount -> ByteCount -> Bool # (<=) :: ByteCount -> ByteCount -> Bool # (>) :: ByteCount -> ByteCount -> Bool # (>=) :: ByteCount -> ByteCount -> Bool # max :: ByteCount -> ByteCount -> ByteCount # min :: ByteCount -> ByteCount -> ByteCount #

newtype WordCount Source #

A quantity of 64-bit words

Constructors

WordCount Int

Instances

Instances details

Bits WordCount Source #
Instance details Defined in Capnp.Bits Methods (.&.) :: WordCount -> WordCount -> WordCount # (.\|.) :: WordCount -> WordCount -> WordCount # xor :: WordCount -> WordCount -> WordCount # complement :: WordCount -> WordCount # shift :: WordCount -> Int -> WordCount # rotate :: WordCount -> Int -> WordCount # zeroBits :: WordCount # bit :: Int -> WordCount # setBit :: WordCount -> Int -> WordCount # clearBit :: WordCount -> Int -> WordCount # complementBit :: WordCount -> Int -> WordCount # testBit :: WordCount -> Int -> Bool # bitSizeMaybe :: WordCount -> Maybe Int # bitSize :: WordCount -> Int # isSigned :: WordCount -> Bool # shiftL :: WordCount -> Int -> WordCount # unsafeShiftL :: WordCount -> Int -> WordCount # shiftR :: WordCount -> Int -> WordCount # unsafeShiftR :: WordCount -> Int -> WordCount # rotateL :: WordCount -> Int -> WordCount # rotateR :: WordCount -> Int -> WordCount # popCount :: WordCount -> Int #
Bounded WordCount Source #
Instance details Defined in Capnp.Bits Methods minBound :: WordCount # maxBound :: WordCount #
Enum WordCount Source #
Instance details Defined in Capnp.Bits Methods succ :: WordCount -> WordCount # pred :: WordCount -> WordCount # toEnum :: Int -> WordCount # fromEnum :: WordCount -> Int # enumFrom :: WordCount -> [WordCount] # enumFromThen :: WordCount -> WordCount -> [WordCount] # enumFromTo :: WordCount -> WordCount -> [WordCount] # enumFromThenTo :: WordCount -> WordCount -> WordCount -> [WordCount] #
Num WordCount Source #
Instance details Defined in Capnp.Bits Methods (+) :: WordCount -> WordCount -> WordCount # (-) :: WordCount -> WordCount -> WordCount # (*) :: WordCount -> WordCount -> WordCount # negate :: WordCount -> WordCount # abs :: WordCount -> WordCount # signum :: WordCount -> WordCount # fromInteger :: Integer -> WordCount #
Integral WordCount Source #
Instance details Defined in Capnp.Bits Methods quot :: WordCount -> WordCount -> WordCount # rem :: WordCount -> WordCount -> WordCount # div :: WordCount -> WordCount -> WordCount # mod :: WordCount -> WordCount -> WordCount # quotRem :: WordCount -> WordCount -> (WordCount, WordCount) # divMod :: WordCount -> WordCount -> (WordCount, WordCount) # toInteger :: WordCount -> Integer #
Real WordCount Source #
Instance details Defined in Capnp.Bits Methods toRational :: WordCount -> Rational #
Show WordCount Source #
Instance details Defined in Capnp.Bits Methods showsPrec :: Int -> WordCount -> ShowS # show :: WordCount -> String # showList :: [WordCount] -> ShowS #
Eq WordCount Source #
Instance details Defined in Capnp.Bits Methods (==) :: WordCount -> WordCount -> Bool # (/=) :: WordCount -> WordCount -> Bool #
Ord WordCount Source #
Instance details Defined in Capnp.Bits Methods compare :: WordCount -> WordCount -> Ordering # (<) :: WordCount -> WordCount -> Bool # (<=) :: WordCount -> WordCount -> Bool # (>) :: WordCount -> WordCount -> Bool # (>=) :: WordCount -> WordCount -> Bool # max :: WordCount -> WordCount -> WordCount # min :: WordCount -> WordCount -> WordCount #

newtype Word1 Source #

1 bit datatype, in the tradition of Word8, Word16 et al.

Constructors

Word1
Fields word1ToBool :: Bool

Instances

Instances details

Bits Word1 Source #
Instance details Defined in Capnp.Bits Methods (.&.) :: Word1 -> Word1 -> Word1 # (.\|.) :: Word1 -> Word1 -> Word1 # xor :: Word1 -> Word1 -> Word1 # complement :: Word1 -> Word1 # shift :: Word1 -> Int -> Word1 # rotate :: Word1 -> Int -> Word1 # zeroBits :: Word1 # bit :: Int -> Word1 # setBit :: Word1 -> Int -> Word1 # clearBit :: Word1 -> Int -> Word1 # complementBit :: Word1 -> Int -> Word1 # testBit :: Word1 -> Int -> Bool # bitSizeMaybe :: Word1 -> Maybe Int # bitSize :: Word1 -> Int # isSigned :: Word1 -> Bool # shiftL :: Word1 -> Int -> Word1 # unsafeShiftL :: Word1 -> Int -> Word1 # shiftR :: Word1 -> Int -> Word1 # unsafeShiftR :: Word1 -> Int -> Word1 # rotateL :: Word1 -> Int -> Word1 # rotateR :: Word1 -> Int -> Word1 # popCount :: Word1 -> Int #
FiniteBits Word1 Source #
Instance details Defined in Capnp.Bits Methods finiteBitSize :: Word1 -> Int # countLeadingZeros :: Word1 -> Int # countTrailingZeros :: Word1 -> Int #
Bounded Word1 Source #
Instance details Defined in Capnp.Bits Methods minBound :: Word1 # maxBound :: Word1 #
Enum Word1 Source #
Instance details Defined in Capnp.Bits Methods succ :: Word1 -> Word1 # pred :: Word1 -> Word1 # toEnum :: Int -> Word1 # fromEnum :: Word1 -> Int # enumFrom :: Word1 -> [Word1] # enumFromThen :: Word1 -> Word1 -> [Word1] # enumFromTo :: Word1 -> Word1 -> [Word1] # enumFromThenTo :: Word1 -> Word1 -> Word1 -> [Word1] #
Num Word1 Source #
Instance details Defined in Capnp.Bits Methods (+) :: Word1 -> Word1 -> Word1 # (-) :: Word1 -> Word1 -> Word1 # (*) :: Word1 -> Word1 -> Word1 # negate :: Word1 -> Word1 # abs :: Word1 -> Word1 # signum :: Word1 -> Word1 # fromInteger :: Integer -> Word1 #
Integral Word1 Source #
Instance details Defined in Capnp.Bits Methods quot :: Word1 -> Word1 -> Word1 # rem :: Word1 -> Word1 -> Word1 # div :: Word1 -> Word1 -> Word1 # mod :: Word1 -> Word1 -> Word1 # quotRem :: Word1 -> Word1 -> (Word1, Word1) # divMod :: Word1 -> Word1 -> (Word1, Word1) # toInteger :: Word1 -> Integer #
Real Word1 Source #
Instance details Defined in Capnp.Bits Methods toRational :: Word1 -> Rational #
Show Word1 Source #
Instance details Defined in Capnp.Bits Methods showsPrec :: Int -> Word1 -> ShowS # show :: Word1 -> String # showList :: [Word1] -> ShowS #
IsWord Word1 Source #
Instance details Defined in Capnp.Classes Methods fromWord :: Word64 -> Word1 Source # toWord :: Word1 -> Word64 Source #
Eq Word1 Source #
Instance details Defined in Capnp.Bits Methods (==) :: Word1 -> Word1 -> Bool # (/=) :: Word1 -> Word1 -> Bool #
Ord Word1 Source #
Instance details Defined in Capnp.Bits Methods compare :: Word1 -> Word1 -> Ordering # (<) :: Word1 -> Word1 -> Bool # (<=) :: Word1 -> Word1 -> Bool # (>) :: Word1 -> Word1 -> Bool # (>=) :: Word1 -> Word1 -> Bool # max :: Word1 -> Word1 -> Word1 # min :: Word1 -> Word1 -> Word1 #

bitsToBytesCeil :: BitCount -> ByteCount Source #

Convert bits to bytes. Rounds up.

bytesToWordsCeil :: ByteCount -> WordCount Source #

Convert bytes to words. Rounds up.

bytesToWordsFloor :: ByteCount -> WordCount Source #

Convert bytes to words. Rounds down.

wordsToBytes :: WordCount -> ByteCount Source #

Convert words to bytes.

lo :: Word64 -> Word32 Source #

lo and hi extract the low and high 32 bits of a 64-bit word, respectively.

hi :: Word64 -> Word32 Source #

lo and hi extract the low and high 32 bits of a 64-bit word, respectively.

i32 :: Word32 -> Int32 Source #

iN (where N is 32, 30, or 29) extracts the high N bits of its argument, and treats them as a signed 32-bit integer.

i30 :: Word32 -> Int32 Source #

iN (where N is 32, 30, or 29) extracts the high N bits of its argument, and treats them as a signed 32-bit integer.

i29 :: Word32 -> Int32 Source #

iN (where N is 32, 30, or 29) extracts the high N bits of its argument, and treats them as a signed 32-bit integer.

fromLo :: Word32 -> Word64 Source #

fromLo and fromHi convert a 32-bit word to the low or high portion of a 64-bit word. In general, fromHi (hi w) .|. fromLo (lo w) == w.

fromHi :: Word32 -> Word64 Source #

fromLo and fromHi convert a 32-bit word to the low or high portion of a 64-bit word. In general, fromHi (hi w) .|. fromLo (lo w) == w.

fromI32 :: Int32 -> Word32 Source #

fromIN (where N is 32, 30, or 29) treats its argument as the high N bits of a 32-bit word, returning the word. If w < 2 ** N then fromIN (iN w) == w.

fromI30 :: Int32 -> Word32 Source #

fromIN (where N is 32, 30, or 29) treats its argument as the high N bits of a 32-bit word, returning the word. If w < 2 ** N then fromIN (iN w) == w.

fromI29 :: Int32 -> Word32 Source #

fromIN (where N is 32, 30, or 29) treats its argument as the high N bits of a 32-bit word, returning the word. If w < 2 ** N then fromIN (iN w) == w.

bitRange :: Integral a => Word64 -> Int -> Int -> a Source #

bitRange word lo hi is the unsigned integer represented by the bits of word in the range [lo, hi)

replaceBits :: (Bounded a, Integral a) => a -> Word64 -> Int -> Word64 Source #

replaceBits new orig shift replaces the bits [shift, shift+N) in orig with the N bit integer new.