Data.Generics.Record

Magic record operations using Generics

These classes need not be instantiated manually, as GHC can automatically prove valid instances via Generics. Only the Generic class needs to be derived (see examples).

Subtype relationship

class Subtype sub sup where

Structural subtype relationship

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

Minimal complete definition

upcast, smash

Methods

upcast :: sub -> sup

Cast the more specific subtype to the more general supertype

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

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

(GSmash * (Rep a) (Rep b), GUpcast (Rep a) (Rep b), Generic a, Generic b) => Subtype a b

Instances are created by the compiler

Methods

upcast :: a -> b

smash :: b -> a -> a

subtype :: forall sup sub. Subtype sub sup => Lens' sub sup

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

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

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

Magic lens

class HasField field a s | s field -> a where

Records that have a field with a given name.

Minimal complete definition

label

Methods

label :: Lens' s a

Lens focusing on a field with a given name. Compatible with the lens package.

 type Lens' s a
   = forall f. Functor f => (a -> f a) -> s -> f s

>>> human & label @"name" .~ "Tamas"
Human {name = "Tamas", age = 50, address = "London"}

Instances

(Generic s, (~) (Maybe Type) (Contains field (Rep s)) (Just Type a), GHasField field (Rep s) a) => HasField field a s

Instances are generated on the fly for all records that have the required field.

Methods

label :: Lens' s a

Getter and setter

getField :: forall field a s. HasField field a s => s -> a

Get field

>>> getField @"name" human
"Tunyasz"

setField :: forall field a s. HasField field a s => a -> s -> s

Set field

>>> setField @"age" (setField @"name" "Tamas" human) 30
Human {name = "Tamas", age = 30, address = "London"}