Data.Serialize.Describe.Class

Documentation

class Describe a where

Minimal complete definition

Nothing

Associated Types

type Context (m :: (* -> *) -> * -> *) a :: Constraint

Methods

describe :: (MonadTrans m, forall x. Monad x => Monad (m x), Context m a) => DescriptorM m a a

describe :: (Generic a, GDescribe (Rep a), MonadTrans m, forall x. Monad x => Monad (m x)) => DescriptorM m a a

Instances

Describe Bool

Defined in Data.Serialize.Describe.Class

Associated Types

type Context m Bool :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m Bool) => DescriptorM m Bool Bool

Describe Char

Defined in Data.Serialize.Describe.Class

Associated Types

type Context m Char :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m Char) => DescriptorM m Char Char

Describe Int8

Defined in Data.Serialize.Describe.Class

Associated Types

type Context m Int8 :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m Int8) => DescriptorM m Int8 Int8

Describe Word8

Defined in Data.Serialize.Describe.Class

Associated Types

type Context m Word8 :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m Word8) => DescriptorM m Word8 Word8

Describe ()

Defined in Data.Serialize.Describe.Class

Associated Types

type Context m () :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m ()) => DescriptorM m () ()

Describe Remaining

Defined in Data.Serialize.Describe.Combinators.Remaining

Associated Types

type Context m Remaining :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m Remaining) => DescriptorM m Remaining Remaining

Describe NText

Defined in Data.Serialize.Describe.Combinators.NText

Associated Types

type Context m NText :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m NText) => DescriptorM m NText NText

Describe (LE Double)

Defined in Data.Serialize.Describe.Combinators.LE

Associated Types

type Context m (LE Double) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (LE Double)) => DescriptorM m (LE Double) (LE Double)

Describe (LE Float)

Defined in Data.Serialize.Describe.Combinators.LE

Associated Types

type Context m (LE Float) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (LE Float)) => DescriptorM m (LE Float) (LE Float)

Describe (LE Int16)

Defined in Data.Serialize.Describe.Combinators.LE

Associated Types

type Context m (LE Int16) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (LE Int16)) => DescriptorM m (LE Int16) (LE Int16)

Describe (LE Int32)

Defined in Data.Serialize.Describe.Combinators.LE

Associated Types

type Context m (LE Int32) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (LE Int32)) => DescriptorM m (LE Int32) (LE Int32)

Describe (LE Int64)

Defined in Data.Serialize.Describe.Combinators.LE

Associated Types

type Context m (LE Int64) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (LE Int64)) => DescriptorM m (LE Int64) (LE Int64)

Describe (LE Word16)

Defined in Data.Serialize.Describe.Combinators.LE

Associated Types

type Context m (LE Word16) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (LE Word16)) => DescriptorM m (LE Word16) (LE Word16)

Describe (LE Word32)

Defined in Data.Serialize.Describe.Combinators.LE

Associated Types

type Context m (LE Word32) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (LE Word32)) => DescriptorM m (LE Word32) (LE Word32)

Describe (LE Word64)

Defined in Data.Serialize.Describe.Combinators.LE

Associated Types

type Context m (LE Word64) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (LE Word64)) => DescriptorM m (LE Word64) (LE Word64)

KnownNat n => Describe (FText n)

Defined in Data.Serialize.Describe.Combinators.FText

Associated Types

type Context m (FText n) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (FText n)) => DescriptorM m (FText n) (FText n)

Enum e => Describe (ByteEnum e)

Defined in Data.Serialize.Describe.Combinators.ByteEnum

Associated Types

type Context m (ByteEnum e) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (ByteEnum e)) => DescriptorM m (ByteEnum e) (ByteEnum e)

Describe (BE Double)

Defined in Data.Serialize.Describe.Combinators.BE

Associated Types

type Context m (BE Double) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (BE Double)) => DescriptorM m (BE Double) (BE Double)

Describe (BE Float)

Defined in Data.Serialize.Describe.Combinators.BE

Associated Types

type Context m (BE Float) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (BE Float)) => DescriptorM m (BE Float) (BE Float)

Describe (BE Int16)

Defined in Data.Serialize.Describe.Combinators.BE

Associated Types

type Context m (BE Int16) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (BE Int16)) => DescriptorM m (BE Int16) (BE Int16)

Describe (BE Int32)

Defined in Data.Serialize.Describe.Combinators.BE

Associated Types

type Context m (BE Int32) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (BE Int32)) => DescriptorM m (BE Int32) (BE Int32)

Describe (BE Int64)

Defined in Data.Serialize.Describe.Combinators.BE

Associated Types

type Context m (BE Int64) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (BE Int64)) => DescriptorM m (BE Int64) (BE Int64)

Describe (BE Word16)

Defined in Data.Serialize.Describe.Combinators.BE

Associated Types

type Context m (BE Word16) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (BE Word16)) => DescriptorM m (BE Word16) (BE Word16)

Describe (BE Word32)

Defined in Data.Serialize.Describe.Combinators.BE

Associated Types

type Context m (BE Word32) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (BE Word32)) => DescriptorM m (BE Word32) (BE Word32)

Describe (BE Word64)

Defined in Data.Serialize.Describe.Combinators.BE

Associated Types

type Context m (BE Word64) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (BE Word64)) => DescriptorM m (BE Word64) (BE Word64)

(Describe a, Arity n, Vector (Vec n) a, KnownNat n) => Describe (Vec n a)

Defined in Data.Serialize.Describe.Class

Associated Types

type Context m (Vec n a) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (Vec n a)) => DescriptorM m (Vec n a) (Vec n a)

(KnownNat n, Nullable a, Describe a) => Describe (FList n a)

Defined in Data.Serialize.Describe.Combinators.FList

Associated Types

type Context m (FList n a) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (FList n a)) => DescriptorM m (FList n a) (FList n a)

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

Defined in Data.Serialize.Describe.Combinators.Conditional

Associated Types

type Context m (Optional p a) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (Optional p a)) => DescriptorM m (Optional p a) (Optional p a)

(Describe t, Describe a, Integral t) => Describe (LPList t a)

Defined in Data.Serialize.Describe.Combinators.LPList

Associated Types

type Context m (LPList t a) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (LPList t a)) => DescriptorM m (LPList t a) (LPList t a)

(KnownNat n, Describe t, Integral t) => Describe (Const n t)

Defined in Data.Serialize.Describe.Combinators.Const

Associated Types

type Context m (Const n t) :: Constraint

Methods

describe :: (MonadTrans m, forall (x :: Type -> Type). Monad x => Monad (m x), Context m (Const n t)) => DescriptorM m (Const n t) (Const n t)

describeVia

Arguments

:: Name

The type wrapper to inherit describe from; must be of type (* -> *)

-> Name

-> Q [Dec]

An alternative to DerivingVia, as the type variable a of Describe is bound to the type family Context making its role nominal, and subsequently, uncoercible as per the semantics of DerivingVia. A restriction exists, however: both of the types specified must be Coercible.

field :: forall a m s. (Describe a, MonadTrans m, forall x. Monad x => Monad (m x), Context m a) => (s -> a) -> DescriptorM m s a

A descriptor from structure to field.

isoField :: (Describe b, MonadTrans m, forall x. Monad x => Monad (m x), Context m b) => Iso' a b -> (s -> a) -> DescriptorM m s a

Similar to field, but applied to an isomorphism.