Frames.RecF

Documentation

rappend :: Rec k f as -> Rec k f bs -> Rec k f ((++) k as bs)

Two records may be pasted together.

rtraverse :: Applicative h => (forall (x :: u). f x -> h (g x)) -> Rec u f rs -> h (Rec u g rs)

A record may be traversed with respect to its interpretation functor. This can be used to yank (some or all) effects from the fields of the record to the outside of the record.

rdel :: CanDelete r rs => proxy r -> Rec f rs -> Rec f (RDelete r rs)

Delete a field from a record

type CanDelete r rs = (RElem r rs (RIndex r rs), RDelete r rs ⊆ rs)

A constraint that a field can be deleted from a record.

frameCons :: Functor f => f a -> Rec f rs -> Rec f ((s :-> a) ': rs)

Add a column to the head of a row.

frameConsA :: Applicative f => a -> Rec f rs -> Rec f ((s :-> a) ': rs)

Add a pure column to the head of a row.

frameSnoc :: Rec f rs -> f r -> Rec f (rs ++ '[r])

Add a column to the tail of a row. Note that the supplied value should be a Col to work with the Frames tooling.

pattern (:&) :: Functor f => f r -> Rec f rs -> Rec f ((s :-> r) ': rs)

pattern Nil :: Rec f '[]

type AllCols c ts = AllConstrained c (UnColumn ts)

Enforce a constraint on the payload type of each column.

type family UnColumn ts where ...

Strip the column information from each element of a list of types.

Equations

UnColumn '[] = '[]

UnColumn ((s :-> t) ': ts) = t ': UnColumn ts

class AsVinyl ts where

Remove the column name phantom types from a record, leaving you with an unadorned Vinyl Rec.

Minimal complete definition

toVinyl, fromVinyl

Methods

toVinyl :: Functor f => Rec f ts -> Rec f (UnColumn ts)

fromVinyl :: Functor f => Rec f (UnColumn ts) -> Rec f ts

Instances

AsVinyl ([] *)

Methods

toVinyl :: Functor f => Rec * f [*] -> Rec * f (UnColumn [*])

fromVinyl :: Functor f => Rec * f (UnColumn [*]) -> Rec * f [*]

AsVinyl ts => AsVinyl ((:) * ((:->) s t) ts)

Methods

toVinyl :: Functor f => Rec * f ((* ': (s :-> t)) ts) -> Rec * f (UnColumn ((* ': (s :-> t)) ts))

fromVinyl :: Functor f => Rec * f (UnColumn ((* ': (s :-> t)) ts)) -> Rec * f ((* ': (s :-> t)) ts)

mapMono :: (AllAre a (UnColumn ts), AsVinyl ts, Functor f, AsVinyl (ReplaceColumns b ts), ReplaceAll b (UnColumn ts) ~ UnColumn (ReplaceColumns b ts)) => (a -> b) -> Rec f ts -> Rec f (ReplaceColumns b ts)

Map a function across a homogeneous, monomorphic Rec.

mapMethod :: forall c f ts. (Functor f, AllConstrained c (UnColumn ts), AsVinyl ts) => (forall a. c a => a -> a) -> Rec f ts -> Rec f ts

Map a typeclass method across a Rec each of whose fields has an instance of the typeclass.

runcurry :: (Functor f, AsVinyl ts) => CurriedF f (UnColumn ts) a -> Rec f ts -> a

N-ary version of uncurry over functorial frame rows. See runcurry.

runcurry' :: AsVinyl ts => Curried (UnColumn ts) a -> Rec Identity ts -> a

N-ary version of uncurry over pure frame rows. See runcurry'.

runcurryA :: (Applicative f, Functor g, AsVinyl ts) => CurriedF g (UnColumn ts) a -> Rec (Compose f g) ts -> f a

Lift an N-ary function over types in g to work over a record of Composed Applicative computations. A more general version of runcurryA'.

runcurryA' :: (Applicative f, AsVinyl ts) => Curried (UnColumn ts) a -> Rec f ts -> f a

Lift an N-ary function to work over a row of Applicative computations. See runcurryA.

class Functor f => ShowRec f rs

The ability to pretty print a Rec's fields.

Minimal complete definition

showRec'

Instances

Functor f => ShowRec f ([] *)

Methods

showRec' :: Rec * f [*] -> [String]

(KnownSymbol s, Show (f (Col' s a)), ShowRec f rs) => ShowRec f ((:) * ((:->) s a) rs)

Methods

showRec' :: Rec * f ((* ': (s :-> a)) rs) -> [String]

showRec :: ShowRec f rs => Rec f rs -> String

Pretty printing of Rec values.

type family ColFun f x where ...

A type function to convert a Record to a Rec. ColFun f (Rec rs) = Rec f rs.

Equations

ColFun f (Rec Identity rs) = Rec f rs

class ColumnHeaders (cs :: [*]) where

Minimal complete definition

columnHeaders

Methods

columnHeaders :: proxy (Rec f cs) -> [String]

Return the column names for a record.

Instances

ColumnHeaders ([] *)

Methods

columnHeaders :: proxy (Rec * f [*]) -> [String]

(ColumnHeaders cs, KnownSymbol s) => ColumnHeaders ((:) * ((:->) s c) cs)

Methods

columnHeaders :: proxy (Rec * f ((* ': (s :-> c)) cs)) -> [String]

columnHeaders :: ColumnHeaders cs => proxy (Rec f cs) -> [String]

Return the column names for a record.

reifyDict :: forall c f proxy ts. (AllConstrained c ts, RecApplicative ts) => proxy c -> (forall a. c a => f a) -> Rec f ts

Build a record whose elements are derived solely from a constraint satisfied by each.