Data.Vinyl · vinyl-0.14.3 · horizon-platform

classclass RecMapMethod (c :: Type -> Constraint) (f :: u -> Type) (ts :: [u]) where

Apply a typeclass method to each field of a Rec where the class constrains the index of the field, but not its interpretation functor.

Methods

rmapMethod :: (forall (a :: u). c (PayloadType f a) => f a -> g a) -> Rec f ts -> Rec g ts

Instances2RecMapMethod

RecMapMethod c f '[]Defined in vinyl-0.14.3 · Data.Vinyl.Class.Method
(c (PayloadType f t), RecMapMethod c f ts) => RecMapMethod c f (t ': ts)Defined in vinyl-0.14.3 · Data.Vinyl.Class.Method

classclass RecPointed (c :: Type -> Constraint) (f :: u -> Type) (ts :: [u]) where

#

Generate a record from fields derived from type class instances.

Methods

rpointMethod :: (forall (a :: u). c (f a) => f a) -> Rec f ts

Instances2RecPointed

RecPointed c f '[]Defined in vinyl-0.14.3 · Data.Vinyl.Class.Method
(c (f t), RecPointed c f ts) => RecPointed c f (t ': ts)Defined in vinyl-0.14.3 · Data.Vinyl.Class.Method

valuermapMethodF

:: (Functor f, FieldPayload f ~ 'FieldId, RecMapMethod c f ts)
=> forall a. c a => a -> a
-> Rec f ts
-> Rec f ts

#

Apply a typeclass method to each field of a Rec f ts using the Functor instance for f to lift the function into the functor. This is a commonly-used specialization of rmapMethod composed with fmap.

valuemapFields

:: RecMapMethod c ElField ts
=> forall a. c a => a -> a
-> FieldRec ts
-> FieldRec ts

#

Apply a typeclass method to each field of a FieldRec. This is a specialization of rmapMethod.

valuertraverseInMethod

:: (RMap rs, RPureConstrained c rs, RApply rs)
=> forall (a :: u). c a => f a -> g (ApplyToField h a)
-> Rec f rs
-> Rec g (MapTyCon h rs)

#

Like rtraverseIn, but the function between functors may be constrained.

valuersequenceInFields

:: (Functor f, AllFields rs, RMap rs)
=> Rec (f :. ElField) rs
-> Rec ElField (MapTyCon f rs)

#

Push an outer layer of interpretation functor into each named field.

newtypenewtype ARec (f :: k -> Type) (ts :: [k])

#

An array-backed extensible record with constant-time field access.

Instances9RecSubset, RecElem, Eq, Ord, Show, RecElemFCtx, …

(is ~ RImage rs ss, IndexWitnesses is, NatToInt (RLength rs)) => RecSubset ARec rs ss isDefined in vinyl-0.14.3 · Data.Vinyl.ARec.Internal
RecElem ARec t t' (t ': ts) (t' ': ts) 'ZDefined in vinyl-0.14.3 · Data.Vinyl.ARec.Internal
(RIndex t (s ': ts) ~ 'S i, NatToInt i, RecElem ARec t t' ts ts' i) => RecElem ARec t t' (s ': ts) (s ': ts') ('S i)Defined in vinyl-0.14.3 · Data.Vinyl.ARec.Internal
(RPureConstrained (IndexableField rs) rs, RecApplicative rs, Eq (Rec f rs)) => Eq (ARec f rs)Defined in vinyl-0.14.3 · Data.Vinyl.ARec.Internal
(RPureConstrained (IndexableField rs) rs, RecApplicative rs, Ord (Rec f rs)) => Ord (ARec f rs)Defined in vinyl-0.14.3 · Data.Vinyl.ARec.Internal
(RPureConstrained (IndexableField rs) rs, RecApplicative rs, Show (Rec f rs)) => Show (ARec f rs)Defined in vinyl-0.14.3 · Data.Vinyl.ARec.Internal
type RecElemFCtx ARec f = ()Defined in vinyl-0.14.3 · Data.Vinyl.ARec.Internal
type RecElemFCtx ARec f = ()Defined in vinyl-0.14.3 · Data.Vinyl.ARec.Internal
type RecSubsetFCtx ARec f = ()Defined in vinyl-0.14.3 · Data.Vinyl.ARec.Internal

valuetoARec :: (NatToInt (RLength ts), ToARec ts) => Rec f ts -> ARec f ts

#

Convert a Rec into an ARec for constant-time field access.

valuefromARec

:: (RecApplicative ts, RPureConstrained (IndexableField ts) ts)
=> ARec f ts
-> Rec f ts

#

Convert an ARec into a Rec.

methodrecord :: t -> UncurriedRec (TupleToRecArgs f t)

#

valuefieldRec

:: TupleRec ElField t
=> t
-> UncurriedRec (TupleToRecArgs ElField t)

#

Build a FieldRec from a tuple of ElField values.

valueruple :: (IsoXRec f ts, TupleXRec f ts) => Rec f ts -> ListToHKDTuple f ts

#

Convert a Rec to a tuple going through HKD to reduce syntactic noise. Useful for pattern matching on an entire Rec.

valuexrec :: (IsoXRec f t, TupleXRec f t) => ListToHKDTuple f t -> Rec f t

#

Build a Rec from a tuple passing through XRec. This admits the most concise syntax for building a Rec. For example, xrec ("joe", 23) :: Rec Identity '[String, Int].

methodxrecX :: ListToHKDTuple f t -> XRec f t

#

Build an XRec from a tuple.

methodxrecTuple :: XRec f t -> ListToHKDTuple f t

#

Convert an XRec to a tuple. Useful for pattern matching on an entire record.

newtypenewtype ElField (t :: (Symbol, Type))

#

A value with a phantom Symbol label. It is not a Haskell Functor, but it is used in many of the same places a Functor is used in vinyl.

Morally: newtype ElField (s, t) = Field t But GHC doesn't allow that

Constructors

Field (Snd t)

Instances19Eq, Floating, Fractional, Num, Ord, Real, …

Eq t => Eq (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
(Floating t, KnownSymbol s) => Floating (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
(Fractional t, KnownSymbol s) => Fractional (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
(Num t, KnownSymbol s) => Num (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
Ord t => Ord (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
(Real t, KnownSymbol s) => Real (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
(RealFrac t, KnownSymbol s) => RealFrac (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
(Show t, KnownSymbol s) => Show (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
KnownSymbol s => Generic (ElField '(s, a))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
Semigroup t => Semigroup (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
(KnownSymbol s, Monoid t) => Monoid (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
(KnownSymbol s, Storable t) => Storable (ElField '(s, t))Defined in vinyl-0.14.3 · Data.Vinyl.Functor
KnownSymbol s => IsoHKD ElField '(s, a)Defined in vinyl-0.14.3 · Data.Vinyl.XRec
Work with values of type ElField '(s,a) as if they were of type a.
(i ~ RIndex t ts, NatToInt i, FieldOffset ElField ts t, Storable (Rec ElField ts), AllConstrained (FieldOffset ElField ts) ts) => RecElem (SRec2 ElField) t t ts ts iDefined in vinyl-0.14.3 · Data.Vinyl.SRec
Field accessors for SRec2 specialized to ElField as the functor.
(is ~ RImage rs ss, RecSubset Rec rs ss is, Storable (Rec ElField rs), Storable (Rec ElField ss), RPureConstrained (FieldOffset ElField ss) rs, RPureConstrained (FieldOffset ElField rs) rs, RFoldMap rs, RMap rs, RApply rs) => RecSubset (SRec2 ElField) rs ss isDefined in vinyl-0.14.3 · Data.Vinyl.SRec
type Rep (ElField '(s, a)) = C1 ('MetaCons s 'PrefixI 'False) (Rec0 a)Defined in vinyl-0.14.3 · Data.Vinyl.Functor
type RecElemFCtx (SRec2 ElField) f = f ~ ElFieldDefined in vinyl-0.14.3 · Data.Vinyl.SRec
type RecSubsetFCtx (SRec2 ElField) f = f ~ ElFieldDefined in vinyl-0.14.3 · Data.Vinyl.SRec
type HKD ElField '(s, a) = aDefined in vinyl-0.14.3 · Data.Vinyl.XRec

newtypenewtype SRec (f :: k -> Type) (ts :: [k])

#

A simpler type for SRec2 whose RecElem and RecSubset instances are specialized to the ElField functor.

Instances4RecElem, RecSubset, RecElemFCtx, RecSubsetFCtx

(i ~ RIndex t ts, NatToInt i, FieldOffset ElField ts t, Storable (Rec ElField ts), AllConstrained (FieldOffset ElField ts) ts) => RecElem SRec t t ts ts iDefined in vinyl-0.14.3 · Data.Vinyl.SRec
(is ~ RImage rs ss, RecSubset Rec rs ss is, Storable (Rec ElField rs), Storable (Rec ElField ss), RPureConstrained (FieldOffset ElField ss) rs, RPureConstrained (FieldOffset ElField rs) rs, RFoldMap rs, RMap rs, RApply rs) => RecSubset SRec rs ss isDefined in vinyl-0.14.3 · Data.Vinyl.SRec
type RecElemFCtx SRec f = f ~ ElFieldDefined in vinyl-0.14.3 · Data.Vinyl.SRec
type RecSubsetFCtx SRec f = f ~ ElFieldDefined in vinyl-0.14.3 · Data.Vinyl.SRec

valuetoSRec :: Storable (Rec f ts) => Rec f ts -> SRec f ts

#

Create an SRec from a Rec. This should offer very fast field access, but note that its lens API (via RecElem and RecSubset) is restricted to the ElField functor.

valuefromSRec :: Storable (Rec f ts) => SRec f ts -> Rec f ts

#

Create a Rec from an SRec.

typetype XRec (f :: u -> Type) = Rec (XData f)

#

patternpattern (::&) :: HKD f r -> XRec f rs -> XRec f (r ': rs)

#

patternpattern XRNil :: XRec f '[]

#

classclass IsoXRec (f :: u -> Type) (ts :: [u]) 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

Instances2IsoXRec

IsoXRec f '[]Defined in vinyl-0.14.3 · Data.Vinyl.XRec
(IsoXRec f ts, IsoHKD f t) => IsoXRec f (t ': ts)Defined in vinyl-0.14.3 · Data.Vinyl.XRec

valuexrmap

:: XRMap f g rs
=> forall (a :: u). 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.

classclass XRApply (f :: u -> Type) (g :: u -> Type) (rs :: [u]) 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

Instances2XRApply

XRApply f g '[]Defined in vinyl-0.14.3 · Data.Vinyl.XRec
XRApply f g rs => XRApply f g (r ': rs)Defined in vinyl-0.14.3 · Data.Vinyl.XRec

valuermapX

:: (XRMap f g rs, IsoXRec f rs, IsoXRec g rs)
=> forall (a :: u). 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.

classclass XRMap (f :: u -> Type) (g :: u -> Type) (rs :: [u]) 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.

Instances2XRMap

XRMap f g '[]Defined in vinyl-0.14.3 · Data.Vinyl.XRec
(XRMap f g rs, IsoHKD f r, IsoHKD g r) => XRMap f g (r ': rs)Defined in vinyl-0.14.3 · Data.Vinyl.XRec