Data.Generics.Sum.Subtype

Structural subtype relationships between sum types.

Prisms

Running example:

>>> :set -XTypeApplications
>>> :set -XDataKinds
>>> :set -XDeriveGeneric
>>> import GHC.Generics
>>> import Control.Lens
>>> :{
data Animal
  = Dog Dog
  | Cat Name Age
  | Duck Age
  deriving (Generic, Show)
data FourLeggedAnimal
  = Dog4 Dog
  | Cat4 Name Age
  deriving (Generic, Show)
data Dog = MkDog
  { name :: Name
  , age  :: Age
  }
  deriving (Generic, Show)
type Name = String
type Age  = Int
dog, cat, duck :: Animal
dog = Dog (MkDog "Shep" 3)
cat = Cat "Mog" 5
duck = Duck 2
dog4, cat4 :: FourLeggedAnimal
dog4 = Dog4 (MkDog "Snowy" 4)
cat4 = Cat4 "Garfield" 6
:}

class AsSubtype sub sup where

Structural subtyping between sums. A sum Sub is a subtype of another sum Sup if a value of Sub can be given (modulo naming of constructors) whenever a value of Sup is expected. In the running example for instance, FourLeggedAnimal is a subtype of Animal since a value of the former can be given as a value of the latter (renaming Dog4 to Dog and Cat4 to Cat).

Minimal complete definition

injectSub, projectSub | _Sub

Methods

_Sub :: Prism' sup sub

A prism that captures structural subtyping. Allows a substructure to be injected (upcast) into a superstructure or a superstructure to be downcast into a substructure (which may fail).

>>> _Sub # dog4 :: Animal
Dog (MkDog {name = "Snowy", age = 4})

>>> cat ^? _Sub :: Maybe FourLeggedAnimal
Just (Cat4 "Mog" 5)

>>> duck ^? _Sub :: Maybe FourLeggedAnimal
Nothing

injectSub :: sub -> sup

Injects a subtype into a supertype (upcast).

projectSub :: sup -> Maybe sub

Projects a subtype from a supertype (downcast).

Instances

AsSubtype a Void

See Note [Uncluttering type signatures] _Sub :: (AsSubtype sub sup, Data.Profunctor.Choice.Choice p, Applicative f) => p sub (f sub) -> p sup (f sup)

Defined in Data.Generics.Sum.Subtype

Methods

_Sub :: Prism' Void a

injectSub :: a -> Void

projectSub :: Void -> Maybe a

AsSubtype a a

Reflexive case >>> _Sub # dog :: Animal Dog (MkDog {name = Shep, age = 3})

Defined in Data.Generics.Sum.Subtype

Methods

_Sub :: Prism' a a

injectSub :: a -> a

projectSub :: a -> Maybe a

Context sub sup => AsSubtype sub sup

Defined in Data.Generics.Sum.Subtype

Methods

_Sub :: Prism' sup sub

injectSub :: sub -> sup

projectSub :: sup -> Maybe sub

AsSubtype Void a

See Note [Uncluttering type signatures] >>> :t _Sub Int _Sub Int :: (AsSubtype Int sup, Choice p, Applicative f) => p Int (f Int) -> p sup (f sup)

Defined in Data.Generics.Sum.Subtype

Methods

_Sub :: Prism' a Void

injectSub :: Void -> a

projectSub :: a -> Maybe Void