Ivory.BitData.Monad

Documentation

newtype BitDataM d a

An action that modifies a bit data value of type d and returns a a in the Ivory s r monad. Values of this type are passed as the body argument to withBits etc.

Constructors

BitDataM

Fields

runBitDataM :: State d a

Instances

Monad (BitDataM d)

Functor (BitDataM d)

clear :: BitData d => BitDataM d ()

Clear the value of the current bit data value.

setBit :: BitData d => BitDataField d Bit -> BitDataM d ()

Set a single bit field in the current bit data value.

clearBit :: BitData d => BitDataField d Bit -> BitDataM d ()

Clear a single bit.

setField :: (BitData d, BitData b, SafeCast (BitDataRep b) (BitDataRep d)) => BitDataField d b -> b -> BitDataM d ()

Set a field to a value.

runBits :: BitData d => BitDataRep d -> BitDataM d a -> (a, BitDataRep d)

Execute a bitdata action given an initial value, returning the new bitdata value and the result of the action.

withBits :: BitData d => BitDataRep d -> BitDataM d () -> BitDataRep d

Execute a bitdata action given an initial value, returning the new bitdata value.

withBitsRef :: BitData d => Ref s1 (Stored (BitDataRep d)) -> BitDataM d a -> Ivory eff a

Execute a bit data action given a reference to a value, writing the resulting value back to the reference upon completion and returning the result of the action.