Data.Extensible.Bits

Bit-packed records

Documentation

newtype BitProd r (h :: k -> Type) (xs :: [k])

Bit-vector product. It has similar interface as (:*) but fields are packed into r.

Constructors

BitProd

Fields

• unBitProd :: r

Instances

(Corepresentable p, Comonad (Corep p), Functor f) => Extensible f p (BitProd r :: (k -> Type) -> [k] -> Type)

Defined in Data.Extensible.Bits

Associated Types

type ExtensibleConstr (BitProd r) h xs x :: Constraint

Methods

pieceAt :: ExtensibleConstr (BitProd r) h xs x => Membership xs x -> Optic' p f (BitProd r h xs) (h x)

(Bits r, KnownNat (TotalBits h xs)) => FromBits r (BitProd r h xs)

Defined in Data.Extensible.Bits

Associated Types

type BitWidth (BitProd r h xs) :: Nat

Methods

fromBits :: r -> BitProd r h xs

toBits :: BitProd r h xs -> r

Bounded r => Bounded (BitProd r h xs)

Defined in Data.Extensible.Bits

Methods

minBound :: BitProd r h xs

maxBound :: BitProd r h xs

Enum r => Enum (BitProd r h xs)

Defined in Data.Extensible.Bits

Methods

succ :: BitProd r h xs -> BitProd r h xs

pred :: BitProd r h xs -> BitProd r h xs

toEnum :: Int -> BitProd r h xs

fromEnum :: BitProd r h xs -> Int

enumFrom :: BitProd r h xs -> [BitProd r h xs]

enumFromThen :: BitProd r h xs -> BitProd r h xs -> [BitProd r h xs]

enumFromTo :: BitProd r h xs -> BitProd r h xs -> [BitProd r h xs]

enumFromThenTo :: BitProd r h xs -> BitProd r h xs -> BitProd r h xs -> [BitProd r h xs]

Eq r => Eq (BitProd r h xs)

Defined in Data.Extensible.Bits

Methods

(==) :: BitProd r h xs -> BitProd r h xs -> Bool

(/=) :: BitProd r h xs -> BitProd r h xs -> Bool

Ord r => Ord (BitProd r h xs)

Defined in Data.Extensible.Bits

Methods

compare :: BitProd r h xs -> BitProd r h xs -> Ordering

(<) :: BitProd r h xs -> BitProd r h xs -> Bool

(<=) :: BitProd r h xs -> BitProd r h xs -> Bool

(>) :: BitProd r h xs -> BitProd r h xs -> Bool

(>=) :: BitProd r h xs -> BitProd r h xs -> Bool

max :: BitProd r h xs -> BitProd r h xs -> BitProd r h xs

min :: BitProd r h xs -> BitProd r h xs -> BitProd r h xs

(Forall (Instance1 Show h) xs, BitFields r h xs) => Show (BitProd r h xs)

Defined in Data.Extensible.Bits

Methods

showsPrec :: Int -> BitProd r h xs -> ShowS

show :: BitProd r h xs -> String

showList :: [BitProd r h xs] -> ShowS

Ix r => Ix (BitProd r h xs)

Defined in Data.Extensible.Bits

Methods

range :: (BitProd r h xs, BitProd r h xs) -> [BitProd r h xs]

index :: (BitProd r h xs, BitProd r h xs) -> BitProd r h xs -> Int

unsafeIndex :: (BitProd r h xs, BitProd r h xs) -> BitProd r h xs -> Int

inRange :: (BitProd r h xs, BitProd r h xs) -> BitProd r h xs -> Bool

rangeSize :: (BitProd r h xs, BitProd r h xs) -> Int

unsafeRangeSize :: (BitProd r h xs, BitProd r h xs) -> Int

Generic (BitProd r h xs)

Defined in Data.Extensible.Bits

Associated Types

type Rep (BitProd r h xs) :: Type -> Type

Methods

from :: BitProd r h xs -> Rep (BitProd r h xs) x

to :: Rep (BitProd r h xs) x -> BitProd r h xs

Hashable r => Hashable (BitProd r h xs)

Defined in Data.Extensible.Bits

Methods

hashWithSalt :: Int -> BitProd r h xs -> Int

hash :: BitProd r h xs -> Int

Storable r => Storable (BitProd r h xs)

Defined in Data.Extensible.Bits

Methods

sizeOf :: BitProd r h xs -> Int

alignment :: BitProd r h xs -> Int

peekElemOff :: Ptr (BitProd r h xs) -> Int -> IO (BitProd r h xs)

pokeElemOff :: Ptr (BitProd r h xs) -> Int -> BitProd r h xs -> IO ()

peekByteOff :: Ptr b -> Int -> IO (BitProd r h xs)

pokeByteOff :: Ptr b -> Int -> BitProd r h xs -> IO ()

peek :: Ptr (BitProd r h xs) -> IO (BitProd r h xs)

poke :: Ptr (BitProd r h xs) -> BitProd r h xs -> IO ()

type ExtensibleConstr (BitProd r :: (k -> Type) -> [k] -> Type) (h :: k -> Type) (xs :: [k]) (x :: k)

Defined in Data.Extensible.Bits

type ExtensibleConstr (BitProd r :: (k -> Type) -> [k] -> Type) (h :: k -> Type) (xs :: [k]) (x :: k) = (BitFields r h xs, FromBits r (h x))

type Rep (BitProd r h xs)

Defined in Data.Extensible.Bits

type Rep (BitProd r h xs) = D1 (MetaData "BitProd" "Data.Extensible.Bits" "extensible-0.5.1-JDHLywB3xCe6o2NgqhJoZx" True) (C1 (MetaCons "BitProd" PrefixI True) (S1 (MetaSel (Just "unBitProd") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 r)))

type BitWidth (BitProd r h xs)

Defined in Data.Extensible.Bits

type BitWidth (BitProd r h xs) = TotalBits h xs

class (Bits r, KnownNat (BitWidth a)) => FromBits r a where

Conversion between a value and a bit representation.

Instances of FromBits must satisfy the following laws:

fromBits (x `shiftL` W .|. toBits a) ≡ a
toBits a `shiftR` W == zeroBits

where W is the BitWidth.

Associated Types

type BitWidth a :: Nat

Methods

fromBits :: r -> a

toBits :: a -> r

Instances

FromBits Word64 Bool

Defined in Data.Extensible.Bits

Associated Types

type BitWidth Bool :: Nat

Methods

fromBits :: Word64 -> Bool

toBits :: Bool -> Word64

FromBits Word64 Int8

Defined in Data.Extensible.Bits

Associated Types

type BitWidth Int8 :: Nat

Methods

fromBits :: Word64 -> Int8

toBits :: Int8 -> Word64

FromBits Word64 Int16

Defined in Data.Extensible.Bits

Associated Types

type BitWidth Int16 :: Nat

Methods

fromBits :: Word64 -> Int16

toBits :: Int16 -> Word64

FromBits Word64 Int32

Defined in Data.Extensible.Bits

Associated Types

type BitWidth Int32 :: Nat

Methods

fromBits :: Word64 -> Int32

toBits :: Int32 -> Word64

FromBits Word64 Word8

Defined in Data.Extensible.Bits

Associated Types

type BitWidth Word8 :: Nat

Methods

fromBits :: Word64 -> Word8

toBits :: Word8 -> Word64

FromBits Word64 Word16

Defined in Data.Extensible.Bits

Associated Types

type BitWidth Word16 :: Nat

Methods

fromBits :: Word64 -> Word16

toBits :: Word16 -> Word64

FromBits Word64 Word32

Defined in Data.Extensible.Bits

Associated Types

type BitWidth Word32 :: Nat

Methods

fromBits :: Word64 -> Word32

toBits :: Word32 -> Word64

FromBits Word64 Word64

Defined in Data.Extensible.Bits

Associated Types

type BitWidth Word64 :: Nat

Methods

fromBits :: Word64 -> Word64

toBits :: Word64 -> Word64

Bits r => FromBits r ()

Defined in Data.Extensible.Bits

Associated Types

type BitWidth () :: Nat

Methods

fromBits :: r -> ()

toBits :: () -> r

FromBits r a => FromBits r (Identity a)

Defined in Data.Extensible.Bits

Associated Types

type BitWidth (Identity a) :: Nat

Methods

fromBits :: r -> Identity a

toBits :: Identity a -> r

(FromBits r a, FromBits r b, n ~ (BitWidth a + BitWidth b), n <= BitWidth r, KnownNat n) => FromBits r (a, b)

Defined in Data.Extensible.Bits

Associated Types

type BitWidth (a, b) :: Nat

Methods

fromBits :: r -> (a, b)

toBits :: (a, b) -> r

Bits r => FromBits r (Proxy a)

Defined in Data.Extensible.Bits

Associated Types

type BitWidth (Proxy a) :: Nat

Methods

fromBits :: r -> Proxy a

toBits :: Proxy a -> r

FromBits r a => FromBits r (Const a b)

Defined in Data.Extensible.Bits

Associated Types

type BitWidth (Const a b) :: Nat

Methods

fromBits :: r -> Const a b

toBits :: Const a b -> r

(Bits r, KnownNat (TotalBits h xs)) => FromBits r (BitProd r h xs)

Defined in Data.Extensible.Bits

Associated Types

type BitWidth (BitProd r h xs) :: Nat

Methods

fromBits :: r -> BitProd r h xs

toBits :: BitProd r h xs -> r

(Bits r, FromBits r (h (TargetOf x))) => FromBits r (Field h x)

Defined in Data.Extensible.Bits

Associated Types

type BitWidth (Field h x) :: Nat

Methods

fromBits :: r -> Field h x

toBits :: Field h x -> r

type family TotalBits h xs where ...

Total BitWidth

Equations

TotalBits h '[] = 0

TotalBits h (x ': xs) = BitWidth (h x) + TotalBits h xs

type BitFields r h xs = (FromBits r r, TotalBits h xs <= BitWidth r, Forall (Instance1 (FromBits r) h) xs)

Fields are instances of FromBits and fit in the representation.

blookup :: forall x r h xs. (BitFields r h xs, FromBits r (h x)) => Membership xs x -> BitProd r h xs -> h x

hlookup for BitProd

bupdate :: forall x r h xs. (BitFields r h xs, FromBits r (h x)) => Membership xs x -> BitProd r h xs -> h x -> BitProd r h xs

Update a field of a BitProd.

toBitProd :: forall r h xs. BitFields r h xs => (h :* xs) -> BitProd r h xs

Convert a normal extensible record into a bit record.

fromBitProd :: forall r h xs. BitFields r h xs => BitProd r h xs -> h :* xs

Convert a normal extensible record into a bit record.

type BitRecordOf r h = BitProd r (Field h)

Bit-packed record

type BitRecord r = BitRecordOf r Identity

Bit-packed record