Data.Generic.HKD.Construction

Documentation

class Construct (f :: Type -> Type) (structure :: Type) where

When working with the HKD representation, it is useful to have a way to convert to and from our original type. To do this, we can:

• construct the original type from our HKD representation, and
• deconstruct the original type into our HKD representation.

As an example, we can try (unsuccessfully) to construct an (Int, Bool) tuple from an unpopulated partial structure.

>>> :set -XTypeApplications
>>> import Data.Monoid (Last)

>>> construct (mempty @(HKD (Int, Bool) Last))
Last {getLast = Nothing}

We can also deconstruct a tuple into a partial structure:

>>> deconstruct @[] ("Hello", True)
(,) ["Hello"] [True]

These two methods also satisfy the round-tripping property:

construct (deconstruct x) == [ x :: (Int, Bool, String) ]

Methods

construct :: HKD structure f -> f structure

deconstruct :: structure -> HKD structure f

Instances

(Functor f, Generic structure, GConstruct f (Rep structure)) => Construct f structure

Defined in Data.Generic.HKD.Construction

Methods

construct :: HKD structure f -> f structure

deconstruct :: structure -> HKD structure f

class GConstruct (f :: Type -> Type) (rep :: Type -> Type) where

Methods

gconstruct :: GHKD_ f rep p -> f (rep p)

gdeconstruct :: rep p -> GHKD_ f rep p

Instances

Applicative f => GConstruct f (K1 index inner :: Type -> Type)

Defined in Data.Generic.HKD.Construction

Methods

gconstruct :: GHKD_ f (K1 index inner) p -> f (K1 index inner p)

gdeconstruct :: K1 index inner p -> GHKD_ f (K1 index inner) p

(Applicative f, GConstruct f left, GConstruct f right) => GConstruct f (left :*: right)

Defined in Data.Generic.HKD.Construction

Methods

gconstruct :: GHKD_ f (left :*: right) p -> f ((left :*: right) p)

gdeconstruct :: (left :*: right) p -> GHKD_ f (left :*: right) p

(Functor f, GConstruct f inner) => GConstruct f (M1 index meta inner)

Defined in Data.Generic.HKD.Construction

Methods

gconstruct :: GHKD_ f (M1 index meta inner) p -> f (M1 index meta inner p)

gdeconstruct :: M1 index meta inner p -> GHKD_ f (M1 index meta inner) p