Data.Vinyl.XRec

A variant of Rec whose values have eliminated common syntactic clutter due to Identity, Compose, and ElField type constructors.

A common pain point with using Rec is the mandatory context of each value. A basic record might look like this, Identity "joe" :& Identity 23 :& RNil :: Rec Identity '[String, Int]. The Identity constructors are a nuisance, so we offer a way of avoiding them: "joe" ::& 23 ::& XRNil :: XRec Identity '[String,Int]. Facilities are provided for converting between XRec and Rec so that the Rec API is available even if you choose to use XRec for construction or pattern matching.

Documentation

type XRec f = Rec (XData f)

pattern (::&) :: HKD f r -> XRec f rs -> XRec f (r ': rs) infixr 7

pattern XRNil :: XRec f '[]

rmapX :: forall f g rs. (XRMap f g rs, IsoXRec f rs, IsoXRec g rs) => (forall a. HKD f a -> HKD g a) -> Rec f rs -> Rec g rs

Like rmap, but the supplied function is written against the HKD-simplified types. This is xrmap sandwiched in between fromXRec and toXRec.

rmapXEndo :: forall f rs. (XRMap f f rs, IsoXRec f rs) => (forall a. HKD f a -> HKD f a) -> Rec f rs -> Rec f rs

This is rmapX specialized to a type at which it does not change interpretation functor. This can help with type inference.

xrmap :: forall f g rs. XRMap f g rs => (forall a. HKD f a -> HKD g a) -> XRec f rs -> XRec g rs

This is rmap for XRec. We apply a natural transformation between interpretation functors to transport a record value between interpretations.

newtype XData t a

A wrapper for an HKD-simplified value. That is, noisy value constructors like Identity and Compose are ellided. This is used in the xrmapAux type class method, but may be ignored by users whose needs are met by xrmap and rmapX.

Constructors

XData

Fields

• unX :: HKD t a

class XRMap f g rs where

The implementation of xrmap is broken into a type class to permit unrolling of the recursion across a record. The function mapped across the vector hides the HKD type family under a newtype constructor to help the type checker.

Methods

xrmapAux :: (forall a. XData f a -> XData g a) -> XRec f rs -> XRec g rs

Instances

XRMap (f :: u -> Type) (g :: u -> Type) ([] :: [u])

Defined in Data.Vinyl.XRec

Methods

xrmapAux :: (forall (a :: u0). XData f a -> XData g a) -> XRec f [] -> XRec g []

(XRMap f g rs, IsoHKD f r, IsoHKD g r) => XRMap (f :: a -> Type) (g :: a -> Type) (r ': rs :: [a])

Defined in Data.Vinyl.XRec

Methods

xrmapAux :: (forall (a0 :: u). XData f a0 -> XData g a0) -> XRec f (r ': rs) -> XRec g (r ': rs)

class XRApply f g rs where

Like rapply: record of components f r -> g r may be applied to a record of f to get a record of g.

Methods

xrapply :: XRec (Lift (->) f g) rs -> XRec f rs -> XRec g rs

Instances

XRApply (f :: u -> Type) (g :: u -> Type) ([] :: [u])

Defined in Data.Vinyl.XRec

Methods

xrapply :: XRec (Lift (->) f g) [] -> XRec f [] -> XRec g []

XRApply f g rs => XRApply (f :: a -> Type) (g :: a -> Type) (r ': rs :: [a])

Defined in Data.Vinyl.XRec

Methods

xrapply :: XRec (Lift (->) f g) (r ': rs) -> XRec f (r ': rs) -> XRec g (r ': rs)

class IsoXRec f ts where

Conversion between XRec and Rec. It is convenient to build and consume XRec values to reduce syntactic noise, but Rec has a richer API that is difficult to build around the HKD type family.

Methods

fromXRec :: XRec f ts -> Rec f ts

toXRec :: Rec f ts -> XRec f ts

Instances

IsoXRec (f :: u -> Type) ([] :: [u])

Defined in Data.Vinyl.XRec

Methods

fromXRec :: XRec f [] -> Rec f []

toXRec :: Rec f [] -> XRec f []

(IsoXRec f ts, IsoHKD f t) => IsoXRec (f :: a -> Type) (t ': ts :: [a])

Defined in Data.Vinyl.XRec

Methods

fromXRec :: XRec f (t ': ts) -> Rec f (t ': ts)

toXRec :: Rec f (t ': ts) -> XRec f (t ': ts)

class IsoHKD f a where

Isomorphism between a syntactically noisy value and a concise one. For types like, Identity, we prefer to work with values of the underlying type without writing out the Identity constructor. For Compose f g a, aka (f :. g) a, we prefer to work directly with values of type f (g a).

This involves the so-called higher-kinded data type family. See http://reasonablypolymorphic.com/blog/higher-kinded-data for more discussion.

Minimal complete definition

Nothing

Associated Types

type HKD f a

Methods

unHKD :: HKD f a -> f a

unHKD :: HKD f a ~ f a => HKD f a -> f a

toHKD :: f a -> HKD f a

toHKD :: HKD f a ~ f a => f a -> HKD f a

Instances

(IsoHKD f (HKD g a), IsoHKD g a, Functor f) => IsoHKD (Compose f g :: k -> Type) (a :: k)

Work with values of type Compose f g a as if they were of type f (g a).

Defined in Data.Vinyl.XRec

Associated Types

type HKD (Compose f g) a :: Type

Methods

unHKD :: HKD (Compose f g) a -> Compose f g a

toHKD :: Compose f g a -> HKD (Compose f g) a

(IsoHKD f a, IsoHKD g a) => IsoHKD (Lift ((->) :: Type -> Type -> Type) f g :: k -> Type) (a :: k)

Work with values of type Lift (->) f g a as if they were of type f a -> g a.

Defined in Data.Vinyl.XRec

Associated Types

type HKD (Lift (->) f g) a :: Type

Methods

unHKD :: HKD (Lift (->) f g) a -> Lift (->) f g a

toHKD :: Lift (->) f g a -> HKD (Lift (->) f g) a

IsoHKD Maybe (a :: Type)

Defined in Data.Vinyl.XRec

Associated Types

type HKD Maybe a :: Type

Methods

unHKD :: HKD Maybe a -> Maybe a

toHKD :: Maybe a -> HKD Maybe a

IsoHKD IO (a :: Type)

Defined in Data.Vinyl.XRec

Associated Types

type HKD IO a :: Type

Methods

unHKD :: HKD IO a -> IO a

toHKD :: IO a -> HKD IO a

IsoHKD First (a :: Type)

Defined in Data.Vinyl.XRec

Associated Types

type HKD First a :: Type

Methods

unHKD :: HKD First a -> First a

toHKD :: First a -> HKD First a

IsoHKD Last (a :: Type)

Defined in Data.Vinyl.XRec

Associated Types

type HKD Last a :: Type

Methods

unHKD :: HKD Last a -> Last a

toHKD :: Last a -> HKD Last a

IsoHKD Sum (a :: Type)

Work with values of type Sum a as if they were of type a.

Defined in Data.Vinyl.XRec

Associated Types

type HKD Sum a :: Type

Methods

unHKD :: HKD Sum a -> Sum a

toHKD :: Sum a -> HKD Sum a

IsoHKD Product (a :: Type)

Work with values of type Product a as if they were of type a.

Defined in Data.Vinyl.XRec

Associated Types

type HKD Product a :: Type

Methods

unHKD :: HKD Product a -> Product a

toHKD :: Product a -> HKD Product a

IsoHKD Identity (a :: Type)

Work with values of type Identity a as if they were simple of type a.

Defined in Data.Vinyl.XRec

Associated Types

type HKD Identity a :: Type

Methods

unHKD :: HKD Identity a -> Identity a

toHKD :: Identity a -> HKD Identity a

IsoHKD (Either a :: Type -> Type) (b :: Type)

Defined in Data.Vinyl.XRec

Associated Types

type HKD (Either a) b :: Type

Methods

unHKD :: HKD (Either a) b -> Either a b

toHKD :: Either a b -> HKD (Either a) b

IsoHKD ((,) a :: Type -> Type) (b :: Type)

Defined in Data.Vinyl.XRec

Associated Types

type HKD ((,) a) b :: Type

Methods

unHKD :: HKD ((,) a) b -> (a, b)

toHKD :: (a, b) -> HKD ((,) a) b

KnownSymbol s => IsoHKD ElField ((,) s a :: (Symbol, Type))

Work with values of type ElField '(s,a) as if they were of type a.

Defined in Data.Vinyl.XRec

Associated Types

type HKD ElField (s, a) :: Type

Methods

unHKD :: HKD ElField (s, a) -> ElField (s, a)

toHKD :: ElField (s, a) -> HKD ElField (s, a)

rgetX :: forall a record f rs. (RecElem record a a rs rs (RIndex a rs), RecElemFCtx record f, IsoHKD f a) => record f rs -> HKD f a

Record field getter that pipes the field value through HKD to eliminate redundant newtype wrappings. Usage will typically involve a visible type application to the field type. The definition is similar to, getHKD = toHKD . rget.