Safe Haskell	None
Language	Haskell2010

Haskus.Binary.Enum

Description

Store an Enum in the given backing word type

Synopsis

data EnumField b a
class CEnum a where
- fromCEnum :: Integral b => a -> b
- toCEnum :: Integral b => b -> a
fromEnumField :: (CEnum a, Integral b) => EnumField b a -> a
toEnumField :: (CEnum a, Integral b) => a -> EnumField b a
makeEnum :: forall a i. (Data a, Integral i) => i -> a
makeEnumMaybe :: forall a i. (Data a, Integral i) => i -> Maybe a
makeEnumWithCustom :: forall a i. (Data a, Integral i) => i -> a
dataToTag :: a -> Int

Documentation

data EnumField b a Source #

Store enum a as a b

Instances

Eq b => Eq (EnumField b a) Source #
Instance details Defined in Haskus.Binary.Enum Methods (==) :: EnumField b a -> EnumField b a -> Bool # (/=) :: EnumField b a -> EnumField b a -> Bool #
Show b => Show (EnumField b a) Source #
Instance details Defined in Haskus.Binary.Enum Methods showsPrec :: Int -> EnumField b a -> ShowS # show :: EnumField b a -> String # showList :: [EnumField b a] -> ShowS #
Storable b => Storable (EnumField b a) Source #
Instance details Defined in Haskus.Binary.Enum Methods peekIO :: Ptr (EnumField b a) -> IO (EnumField b a) Source # pokeIO :: Ptr (EnumField b a) -> EnumField b a -> IO () Source # alignment :: EnumField b a -> Word Source # sizeOf :: EnumField b a -> Word Source #
(Integral b, StaticStorable b, CEnum a) => StaticStorable (EnumField b a) Source #
Instance details Defined in Haskus.Binary.Enum Associated Types type SizeOf (EnumField b a) :: Nat Source # type Alignment (EnumField b a) :: Nat Source # Methods staticPeekIO :: Ptr (EnumField b a) -> IO (EnumField b a) Source # staticPokeIO :: Ptr (EnumField b a) -> EnumField b a -> IO () Source #
(Integral b, CEnum a) => Field (EnumField b a) Source #
Instance details Defined in Haskus.Binary.BitField Methods fromField :: Integral b0 => EnumField b a -> b0 toField :: Integral b0 => b0 -> EnumField b a
type SizeOf (EnumField b a) Source #
Instance details Defined in Haskus.Binary.Enum type SizeOf (EnumField b a) = SizeOf b
type Alignment (EnumField b a) Source #
Instance details Defined in Haskus.Binary.Enum type Alignment (EnumField b a) = Alignment b

class CEnum a where Source #

Extended Enum

By default, use dataToTag and toEnum to convert from and to an Integral.

But it can be overloaded to perform transformation before using fromEnum/toEnum. E.g. if values are shifted by 1 compared to Enum values, define fromCEnum = (+1) . fromIntegral . dataToTag

Minimal complete definition

Nothing

Methods

fromCEnum :: Integral b => a -> b Source #

toCEnum :: Integral b => b -> a Source #

toCEnum :: (Enum a, Integral b) => b -> a Source #

Instances

CEnum Endianness Source #
Instance details Defined in Haskus.Binary.Endianness Methods fromCEnum :: Integral b => Endianness -> b Source # toCEnum :: Integral b => b -> Endianness Source #

fromEnumField :: (CEnum a, Integral b) => EnumField b a -> a Source #

Read an enum field

toEnumField :: (CEnum a, Integral b) => a -> EnumField b a Source #

Create an enum field

makeEnum :: forall a i. (Data a, Integral i) => i -> a Source #

Make an enum from a number (0 indexed)

makeEnumMaybe :: forall a i. (Data a, Integral i) => i -> Maybe a Source #

Make an enum with the last constructor taking a parameter for the rest of the range, but don't build the last constructor

data T = A | B | C | D Word8

makeEnumMaybe :: Int -> T
makeEnumMaybe x = case x of
   0 -> Just A
   1 -> Just B
   2 -> Just C
   n -> Nothing

makeEnumWithCustom :: forall a i. (Data a, Integral i) => i -> a Source #

Make an enum with the last constructor taking a parameter for the rest of the range

data T = A | B | C | D Word8

makeEnumWithCustom :: Int -> T
makeEnumWithCustom x = case x of
   0 -> A
   1 -> B
   2 -> C
   n -> D (n - 3)

dataToTag :: a -> Int Source #

Retrieve data tag

>>> data D = A | B | C
>>> dataToTag B
1