SuperRecord

Basics

data label := value infix 6

Field named l labels value of type t adapted from the awesome labels package. Example: (#name := "Chris") :: ("name" := String)

Constructors

KnownSymbol label => (FldProxy label) := !value infix 6

Instances

KnownSymbol name => FromNative * (S1 (MetaSel (Just Symbol name) p s l) (Rec0 t)) ((:) * ((:=) name t) ([] *))

Methods

fromNative' :: (* ': (name := t)) [*] x -> Rec lts

(RecEq rts (RemoveAccessTo l lts), Has * l rts v, Eq v) => RecEq rts ((:) * ((:=) l t) lts)

Methods

recEq :: Rec rts -> Rec rts -> Proxy [*] ((* ': (l := t)) lts) -> Bool

(KnownSymbol l, RecApply rts (RemoveAccessTo l lts) c, Has * l rts v, c v) => RecApply rts ((:) * ((:=) l t) lts) c

Methods

recApply :: (forall a. Dict (c a) -> String -> a -> b -> b) -> Rec rts -> Proxy [*] ((* ': (l := t)) lts) -> b -> b

Eq value => Eq ((:=) label value)

Methods

(==) :: (label := value) -> (label := value) -> Bool

(/=) :: (label := value) -> (label := value) -> Bool

Ord value => Ord ((:=) label value)

Methods

compare :: (label := value) -> (label := value) -> Ordering

(<) :: (label := value) -> (label := value) -> Bool

(<=) :: (label := value) -> (label := value) -> Bool

(>) :: (label := value) -> (label := value) -> Bool

(>=) :: (label := value) -> (label := value) -> Bool

max :: (label := value) -> (label := value) -> label := value

min :: (label := value) -> (label := value) -> label := value

Show t => Show ((:=) l t)

Methods

showsPrec :: Int -> (l := t) -> ShowS

show :: (l := t) -> String

showList :: [l := t] -> ShowS

(KnownSymbol l, FromJSON t, RecJsonParse lts, (~) Nat (RecSize lts) s, KnownNat s, KeyDoesNotExist l lts) => RecJsonParse ((:) * ((:=) l t) lts)

Methods

recJsonParse :: Int -> Object -> Parser (Rec ((* ': (l := t)) lts))

(KnownSymbol l, RecKeys lts) => RecKeys ((:) * ((:=) l t) lts)

Associated Types

type RecKeysT ((:) * ((:=) l t) lts :: [*]) :: [Symbol]

Methods

recFields :: t ((* ': (l := t)) lts) -> RecFields (RecKeysT ((* ': (l := t)) lts))

(Has * l rts v, NFData v, RecNfData (RemoveAccessTo l lts) rts) => RecNfData ((:) * ((:=) l t) lts) rts

Methods

recNfData :: Proxy [*] ((* ': (l := t)) lts) -> Rec rts -> ()

(Has * l rts t, Has * l lts t, RecCopy (RemoveAccessTo l ((:) * ((:=) l t) pts)) lts rts) => RecCopy ((:) * ((:=) l t) pts) lts rts

Methods

recCopyInto :: Proxy [*] ((* ': (l := t)) pts) -> Rec lts -> Proxy [*] rts -> SmallMutableArray# RealWorld (Any *) -> State# RealWorld -> State# RealWorld

type RecKeysT ((:) * ((:=) l t) lts)

type RecKeysT ((:) * ((:=) l t) lts) = (:) Symbol l (RecKeysT lts)

type Record lts = Rec (Sort lts)

The core record type. Prefer this type when manually writing type signatures

rnil :: Rec '[]

An empty record

rcons :: forall l t lts s. (RecSize lts ~ s, KnownNat s, KnownNat (RecVecIdxPos l (Sort ((l := t) ': lts))), KeyDoesNotExist l lts, RecCopy lts lts (Sort ((l := t) ': lts))) => (l := t) -> Rec lts -> Rec (Sort ((l := t) ': lts))

Prepend a record entry to a record Rec

(&) :: forall l t lts s. (RecSize lts ~ s, KnownNat s, KnownNat (RecVecIdxPos l (Sort ((l := t) ': lts))), KeyDoesNotExist l lts, RecCopy lts lts (Sort ((l := t) ': lts))) => (l := t) -> Rec lts -> Rec (Sort ((l := t) ': lts)) infixr 5

Alias for rcons

fld :: FldProxy l -> FldProxy l

Helper function to allow to clearing specify unknown IsLabel cases

type Has l lts v = (RecTy l lts ~ v, KnownNat (RecSize lts), KnownNat (RecVecIdxPos l lts))

Require a record to contain a label

type family HasOf (req :: [*]) (lts :: [*]) :: Constraint where ...

Require a record to contain at least the listed labels

Equations

HasOf ((l := t) ': req) lts = (Has l lts t, HasOf req lts)

HasOf '[] lts = True ~ True

get :: forall l v lts. Has l lts v => FldProxy l -> Rec lts -> v

Get an existing record field

(&.) :: forall l v lts. Has l lts v => Rec lts -> FldProxy l -> v infixl 3

Alias for get

set :: forall l v lts. Has l lts v => FldProxy l -> v -> Rec lts -> Rec lts

Update an existing record field

modify :: forall l v lts. Has l lts v => FldProxy l -> (v -> v) -> Rec lts -> Rec lts

Update an existing record field

getPath :: RecApplyPath k x => k -> Rec x -> RecDeepTy k x

Perform a deep read. This is somewhat similar to using (&.), but is useful when you want to share a RecPath between getPath, modifyPath and/or setPath

setPath :: RecApplyPath k x => k -> RecDeepTy k x -> Rec x -> Rec x

Perform a deep update, setting the key along the path to the desired value

modifyPath :: RecApplyPath k x => k -> (RecDeepTy k x -> RecDeepTy k x) -> Rec x -> Rec x

Perform a deep update, transforming the value at the final key

class RecApplyPath p x

Minimal complete definition

setPath', getPath'

Instances

(Has * l lts t, (~) * t (RecDeepTy * (FldProxy l) lts)) => RecApplyPath (FldProxy l) lts

Methods

setPath' :: FldProxy l -> (RecDeepTy * (FldProxy l) lts -> RecDeepTy * (FldProxy l) lts) -> Rec lts -> Rec lts

getPath' :: FldProxy l -> Rec lts -> RecDeepTy * (FldProxy l) lts

((~) * (RecDeepTy * ((:&) l more) lts) (RecDeepTy * more rts), (~) * (RecTy * l lts) (Rec rts), Has * l lts v, (~) * v (Rec rts), RecApplyPath more rts) => RecApplyPath ((:&) l more) lts

Methods

setPath' :: (l :& more) -> (RecDeepTy * (l :& more) lts -> RecDeepTy * (l :& more) lts) -> Rec lts -> Rec lts

getPath' :: (l :& more) -> Rec lts -> RecDeepTy * (l :& more) lts

data lbl :& more infixr 8

Constructor for field accessor paths

Instances

((~) * (RecDeepTy * ((:&) l more) lts) (RecDeepTy * more rts), (~) * (RecTy * l lts) (Rec rts), Has * l lts v, (~) * v (Rec rts), RecApplyPath more rts) => RecApplyPath ((:&) l more) lts

Methods

setPath' :: (l :& more) -> (RecDeepTy * (l :& more) lts -> RecDeepTy * (l :& more) lts) -> Rec lts -> Rec lts

getPath' :: (l :& more) -> Rec lts -> RecDeepTy * (l :& more) lts

(&:) :: FldProxy q -> more -> q :& more infixr 8

Constructor for field accessor paths

(&:-) :: FldProxy q -> FldProxy r -> q :& FldProxy r infixr 8

Specialized version of (&:) to help writing the last piece of the path w/o confusing the type checker

combine :: forall lhs rhs. (KnownNat (RecSize lhs), KnownNat (RecSize rhs), KnownNat (RecSize lhs + RecSize rhs), RecCopy lhs lhs (Sort (RecAppend lhs rhs)), RecCopy rhs rhs (Sort (RecAppend lhs rhs))) => Rec lhs -> Rec rhs -> Rec (Sort (RecAppend lhs rhs))

Combine two records

(++:) :: forall lhs rhs. (KnownNat (RecSize lhs), KnownNat (RecSize rhs), KnownNat (RecSize lhs + RecSize rhs), RecCopy lhs lhs (Sort (RecAppend lhs rhs)), RecCopy rhs rhs (Sort (RecAppend lhs rhs))) => Rec lhs -> Rec rhs -> Rec (Sort (RecAppend lhs rhs))

Alias for combine

type RecAppend lhs rhs = RecAppendH lhs rhs rhs '[]

Reflection

reflectRec :: forall c r lts. RecApply lts lts c => Proxy c -> (forall a. c a => String -> a -> r) -> Rec lts -> [r]

Apply a function to each key element pair for a record

reflectRecFold :: forall c r lts. RecApply lts lts c => Proxy c -> (forall a. c a => String -> a -> r -> r) -> Rec lts -> r -> r

Fold over all elements of a record

class RecApply rts lts c where

Machinery needed to implement reflectRec

Minimal complete definition

recApply

Methods

recApply :: (forall a. Dict (c a) -> String -> a -> b -> b) -> Rec rts -> Proxy lts -> b -> b

Instances

RecApply rts ([] *) c

Methods

recApply :: (forall a. Dict (c a) -> String -> a -> b -> b) -> Rec rts -> Proxy [*] [*] -> b -> b

(KnownSymbol l, RecApply rts (RemoveAccessTo l lts) c, Has * l rts v, c v) => RecApply rts ((:) * ((:=) l t) lts) c

Methods

recApply :: (forall a. Dict (c a) -> String -> a -> b -> b) -> Rec rts -> Proxy [*] ((* ': (l := t)) lts) -> b -> b

Native type interop

class FromNative a lts | a -> lts

Conversion helper to bring a Haskell type to a record. Note that the native Haskell type must be an instance of Generic

Minimal complete definition

fromNative'

Instances

(FromNative * l lhs, FromNative * r rhs, (~) [*] lts (Sort (RecAppend lhs rhs)), RecCopy lhs lhs lts, RecCopy rhs rhs lts, KnownNat (RecSize lhs), KnownNat (RecSize rhs), KnownNat ((+) (RecSize lhs) (RecSize rhs))) => FromNative * ((:*:) l r) lts

Methods

fromNative' :: lts x -> Rec lts

FromNative * cs lts => FromNative * (D1 m cs) lts

Methods

fromNative' :: lts x -> Rec lts

FromNative * cs lts => FromNative * (C1 m cs) lts

Methods

fromNative' :: lts x -> Rec lts

KnownSymbol name => FromNative * (S1 (MetaSel (Just Symbol name) p s l) (Rec0 t)) ((:) * ((:=) name t) ([] *))

Methods

fromNative' :: (* ': (name := t)) [*] x -> Rec lts

fromNative :: (Generic a, FromNative (Rep a) lts) => a -> Rec lts

Convert a native Haskell type to a record

class ToNative a lts | a -> lts

Conversion helper to bring a record back into a Haskell type. Note that the native Haskell type must be an instance of Generic

Minimal complete definition

toNative'

Instances

(ToNative * l lts, ToNative * r lts) => ToNative * ((:*:) l r) lts

Methods

toNative' :: Rec lts -> lts x

ToNative * cs lts => ToNative * (D1 m cs) lts

Methods

toNative' :: Rec lts -> lts x

ToNative * cs lts => ToNative * (C1 m cs) lts

Methods

toNative' :: Rec lts -> lts x

Has * name lts t => ToNative * (S1 (MetaSel (Just Symbol name) p s l) (Rec0 t)) lts

Methods

toNative' :: Rec lts -> lts x

toNative :: (Generic a, ToNative (Rep a) lts) => Rec lts -> a

Convert a record to a native Haskell type

MTL interop

asksR :: (Has lbl lts v, MonadReader (Rec lts) m) => FldProxy lbl -> m v

Like asks for MonadReader, but you provide a record field you would like to read from your environment

asksRP :: (RecApplyPath k x, MonadReader (Rec x) m) => k -> m (RecDeepTy k x)

Like asks for MonadReader, but you provide a record field you would like to read from your environment

getsR :: (Has lbl lts v, MonadState (Rec lts) m) => FldProxy lbl -> m v

Like gets for MonadState, but you provide a record field you would like to read from your environment

setsR :: (Has lbl lts v, MonadState (Rec lts) m) => FldProxy lbl -> v -> m ()

Similar to put for MonadState, but you only set a single record field

modifiesR :: (Has lbl lts v, MonadState (Rec lts) m) => FldProxy lbl -> (v -> v) -> m ()

Similar to modify for MonadState, but you update a single record field

getsRP :: (RecApplyPath k x, MonadState (Rec x) m) => k -> m (RecDeepTy k x)

Similar to gets for MonadState, but allows getting a value along a RecPath

setsRP :: (RecApplyPath k x, MonadState (Rec x) m) => k -> RecDeepTy k x -> m ()

Similar to put for MonadState, but you only set a single record field

modifiesRP :: (RecApplyPath k x, MonadState (Rec x) m) => k -> (RecDeepTy k x -> RecDeepTy k x) -> m ()

Similar to modify for MonadState, but you update a single record field

Lens interop

lens :: Has l lts v => FldProxy l -> Lens (Rec lts) (Rec lts) v v

Convert a field label to a lens

Machinery

data Rec lts

Internal record type. When manually writing an explicit type signature for a record, use Record instead. For abstract type signatures Rec will work well.

Instances

RecEq lts lts => Eq (Rec lts)

Methods

(==) :: Rec lts -> Rec lts -> Bool

(/=) :: Rec lts -> Rec lts -> Bool

RecApply lts lts Show => Show (Rec lts)

Methods

showsPrec :: Int -> Rec lts -> ShowS

show :: Rec lts -> String

showList :: [Rec lts] -> ShowS

RecApply lts lts ToJSON => ToJSON (Rec lts)

Methods

toJSON :: Rec lts -> Value

toEncoding :: Rec lts -> Encoding

toJSONList :: [Rec lts] -> Value

toEncodingList :: [Rec lts] -> Encoding

((~) Nat (RecSize lts) s, KnownNat s, RecJsonParse lts) => FromJSON (Rec lts)

Methods

parseJSON :: Value -> Parser (Rec lts)

parseJSONList :: Value -> Parser [Rec lts]

RecNfData lts lts => NFData (Rec lts)

Methods

rnf :: Rec lts -> ()

class RecCopy pts lts rts

Minimal complete definition

recCopyInto

Instances

RecCopy ([] *) lts rts

Methods

recCopyInto :: Proxy [*] [*] -> Rec lts -> Proxy [*] rts -> SmallMutableArray# RealWorld (Any *) -> State# RealWorld -> State# RealWorld

(Has * l rts t, Has * l lts t, RecCopy (RemoveAccessTo l ((:) * ((:=) l t) pts)) lts rts) => RecCopy ((:) * ((:=) l t) pts) lts rts

Methods

recCopyInto :: Proxy [*] ((* ': (l := t)) pts) -> Rec lts -> Proxy [*] rts -> SmallMutableArray# RealWorld (Any *) -> State# RealWorld -> State# RealWorld

type family RecTyIdxH (i :: Nat) (l :: Symbol) (lts :: [*]) :: Nat where ...

Equations

RecTyIdxH idx l ((l := t) ': lts) = idx

RecTyIdxH idx m ((l := t) ': lts) = RecTyIdxH (1 + idx) m lts

RecTyIdxH idx m '[] = TypeError (Text "Could not find label " :<>: Text m)

showRec :: forall lts. RecApply lts lts Show => Rec lts -> [(String, String)]

Convert all elements of a record to a String

class RecKeys lts where

Get keys of a record on value and type level

Minimal complete definition

recFields

Associated Types

type RecKeysT lts :: [Symbol]

Methods

recFields :: t lts -> RecFields (RecKeysT lts)

Instances

RecKeys ([] *)

Associated Types

type RecKeysT ([] * :: [*]) :: [Symbol]

Methods

recFields :: t [*] -> RecFields (RecKeysT [*])

(KnownSymbol l, RecKeys lts) => RecKeys ((:) * ((:=) l t) lts)

Associated Types

type RecKeysT ((:) * ((:=) l t) lts :: [*]) :: [Symbol]

Methods

recFields :: t ((* ': (l := t)) lts) -> RecFields (RecKeysT ((* ': (l := t)) lts))

recKeys :: forall t lts. RecKeys lts => t lts -> [String]

class RecEq rts lts where

Machinery to implement equality

Minimal complete definition

recEq

Methods

recEq :: Rec rts -> Rec rts -> Proxy lts -> Bool

Instances

RecEq rts ([] *)

Methods

recEq :: Rec rts -> Rec rts -> Proxy [*] [*] -> Bool

(RecEq rts (RemoveAccessTo l lts), Has * l rts v, Eq v) => RecEq rts ((:) * ((:=) l t) lts)

Methods

recEq :: Rec rts -> Rec rts -> Proxy [*] ((* ': (l := t)) lts) -> Bool

recToValue :: forall lts. RecApply lts lts ToJSON => Rec lts -> Value

recToEncoding :: forall lts. RecApply lts lts ToJSON => Rec lts -> Encoding

recJsonParser :: forall lts s. (RecSize lts ~ s, KnownNat s, RecJsonParse lts) => Value -> Parser (Rec lts)

class RecJsonParse lts where

Machinery to implement parseJSON

Minimal complete definition

recJsonParse

Methods

recJsonParse :: Int -> Object -> Parser (Rec lts)

Instances

RecJsonParse ([] *)

Methods

recJsonParse :: Int -> Object -> Parser (Rec [*])

(KnownSymbol l, FromJSON t, RecJsonParse lts, (~) Nat (RecSize lts) s, KnownNat s, KeyDoesNotExist l lts) => RecJsonParse ((:) * ((:=) l t) lts)

Methods

recJsonParse :: Int -> Object -> Parser (Rec ((* ': (l := t)) lts))

class RecNfData lts rts where

Machinery for NFData

Minimal complete definition

recNfData

Methods

recNfData :: Proxy lts -> Rec rts -> ()

Instances

RecNfData ([] *) rts

Methods

recNfData :: Proxy [*] [*] -> Rec rts -> ()

(Has * l rts v, NFData v, RecNfData (RemoveAccessTo l lts) rts) => RecNfData ((:) * ((:=) l t) lts) rts

Methods

recNfData :: Proxy [*] ((* ': (l := t)) lts) -> Rec rts -> ()

type family RecSize (lts :: [*]) :: Nat where ...

Equations

RecSize '[] = 0

RecSize ((l := t) ': lts) = 1 + RecSize lts

type family RemoveAccessTo (l :: Symbol) (lts :: [*]) :: [*] where ...

Equations

RemoveAccessTo l ((l := t) ': lts) = RemoveAccessTo l lts

RemoveAccessTo q ((l := t) ': lts) = (l := t) ': RemoveAccessTo l lts

RemoveAccessTo q '[] = '[]

data FldProxy t

A proxy witness for a label. Very similar to Proxy, but needed to implement a non-orphan IsLabel instance

Constructors

FldProxy

Instances

(~) Symbol l l' => IsLabel l (FldProxy l')

Methods

fromLabel :: Proxy# Symbol l -> FldProxy l'

Eq (FldProxy t)

Methods

(==) :: FldProxy t -> FldProxy t -> Bool

(/=) :: FldProxy t -> FldProxy t -> Bool

Ord (FldProxy t)

Methods

compare :: FldProxy t -> FldProxy t -> Ordering

(<) :: FldProxy t -> FldProxy t -> Bool

(<=) :: FldProxy t -> FldProxy t -> Bool

(>) :: FldProxy t -> FldProxy t -> Bool

(>=) :: FldProxy t -> FldProxy t -> Bool

max :: FldProxy t -> FldProxy t -> FldProxy t

min :: FldProxy t -> FldProxy t -> FldProxy t

Read (FldProxy t)

Methods

readsPrec :: Int -> ReadS (FldProxy t)

readList :: ReadS [FldProxy t]

readPrec :: ReadPrec (FldProxy t)

readListPrec :: ReadPrec [FldProxy t]

Show (FldProxy t)

Methods

showsPrec :: Int -> FldProxy t -> ShowS

show :: FldProxy t -> String

showList :: [FldProxy t] -> ShowS

(Has * l lts t, (~) * t (RecDeepTy * (FldProxy l) lts)) => RecApplyPath (FldProxy l) lts

Methods

setPath' :: FldProxy l -> (RecDeepTy * (FldProxy l) lts -> RecDeepTy * (FldProxy l) lts) -> Rec lts -> Rec lts

getPath' :: FldProxy l -> Rec lts -> RecDeepTy * (FldProxy l) lts

type family RecDeepTy (ps :: r) (lts :: [*]) :: * where ...

Equations

RecDeepTy (l :& more) ((l := Rec t) ': lts) = RecDeepTy more t

RecDeepTy (l :& more) ((l := t) ': lts) = t

RecDeepTy (l :& more) ((q := t) ': lts) = RecDeepTy (l :& more) lts

RecDeepTy (FldProxy l) '[l := t] = t

RecDeepTy l '[l := t] = t

type family KeyDoesNotExist (l :: Symbol) (lts :: [*]) :: Constraint where ...

Equations

KeyDoesNotExist l '[] = True ~ True

KeyDoesNotExist l ((l := t) ': lts) = TypeError (Text "Duplicate key " :<>: Text l)

KeyDoesNotExist q ((l := t) ': lts) = KeyDoesNotExist q lts