Data.Serialize.Describe.Combinators

Various type-level combinators to ease generic derivation of Describe

Documentation

newtype Optional p t

An Optional represents a field which is optionally-serializable. The field will be parsed via a lookAhead and, if the value matches the Predicate p, then the field exists. If not, it is assumed as though the field was never serialized in the first place and the value will be set to Nothing; parsing will then continue on as usual.

Constructors

Optional

Fields

• unwrapOptional :: Maybe t

Instances

(Describe a, Predicate a p) => Describe (Optional p a)

Defined in Data.Serialize.Describe.Combinators

Methods

describe :: (s -> Optional p a) -> Descriptor s (Optional p a)

class Predicate t a where

Methods

check :: t -> Bool

Instances

(KnownNat n, Integral i) => Predicate i (Equals n)

Defined in Data.Serialize.Describe.Combinators

Methods

check :: i -> Bool

(KnownNat n1, KnownNat n2, Arity n2, Vector (Vec n2) i, Integral i) => Predicate (Vec n2 i) (Equals n1)

Defined in Data.Serialize.Describe.Combinators

Methods

check :: Vec n2 i -> Bool

data Equals (n :: Nat)

Instances

(KnownNat n, Integral i) => Predicate i (Equals n)

Defined in Data.Serialize.Describe.Combinators

Methods

check :: i -> Bool

(KnownNat n1, KnownNat n2, Arity n2, Vector (Vec n2) i, Integral i) => Predicate (Vec n2 i) (Equals n1)

Defined in Data.Serialize.Describe.Combinators

Methods

check :: Vec n2 i -> Bool