Data.Generics.Product.Subtype

Structural subtype relationships between product types.

Lenses

Running example:

>>> :set -XTypeApplications
>>> :set -XDataKinds
>>> :set -XDeriveGeneric
>>> :set -XDuplicateRecordFields
>>> import GHC.Generics
>>> :m +Data.Generics.Internal.VL.Lens
>>> :{
data Human = Human
  { name    :: String
  , age     :: Int
  , address :: String
  }
  deriving (Generic, Show)
data Animal = Animal
  { name    :: String
  , age     :: Int
  }
  deriving (Generic, Show)
human :: Human
human = Human "Tunyasz" 50 "London"
:}

class Subtype sup sub where

Structural subtype relationship

sub is a (structural) subtype of sup, if its fields are a subset of those of sup.

Minimal complete definition

super | smash, upcast

Methods

super :: Lens sub sub sup sup

Structural subtype lens. Given a subtype relationship sub :< sup, we can focus on the sub structure of sup.

>>> human ^. super @Animal
Animal {name = "Tunyasz", age = 50}

>>> set (super @Animal) (Animal "dog" 10) human
Human {name = "dog", age = 10, address = "London"}

upcast :: sub -> sup

Cast the more specific subtype to the more general supertype

>>> upcast human :: Animal
Animal {name = "Tunyasz", age = 50}

>>> upcast (upcast human :: Animal) :: Human
...
... The type 'Animal' is not a subtype of 'Human'.
... The following fields are missing from 'Animal':
... address
...

smash :: sup -> sub -> sub

Plug a smaller structure into a larger one

>>> smash (Animal "dog" 10) human
Human {name = "dog", age = 10, address = "London"}

Instances

Subtype Void a

Uncluttering type signatures (see Void)

>>> :t +d super @Int
super @Int
  :: (Subtype Int sub, Functor f) => (Int -> f Int) -> sub -> f sub

Defined in Data.Generics.Product.Subtype

Methods

super :: Lens a a Void Void

upcast :: a -> Void

smash :: Void -> a -> a

Subtype a Void

Uncluttering type signatures (see Void)

>>> :t +d super
super
  :: (Subtype sup sub, Functor f) => (sup -> f sup) -> sub -> f sub

Defined in Data.Generics.Product.Subtype

Methods

super :: Lens Void Void a a

upcast :: Void -> a

smash :: a -> Void -> Void

Subtype a a

Defined in Data.Generics.Product.Subtype

Methods

super :: Lens a a a a

upcast :: a -> a

smash :: a -> a -> a

Context a b => Subtype b a

Defined in Data.Generics.Product.Subtype

Methods

super :: Lens a a b b

upcast :: a -> b

smash :: b -> a -> a