Data.Override.Internal

This is the internal generic-override API and should be considered unstable and subject to change. This module is exposed for library integrators (e.g. generic-override-aeson). In general, unless you are integrating some type class with generic-override, you should prefer to use the public, stable API provided by Override.

Documentation

newtype Override a (xs :: [*])

The feature of this library. For use with DerivingVia. Apply it to a type a and supply a type-level list of instance overrides xs.

Constructors

Override a

Instances

(Generic (Override a xs), Eq (Rep (Override a xs) ())) => Eq (Override a xs)

Defined in Data.Override.Instances

Methods

(==) :: Override a xs -> Override a xs -> Bool

(/=) :: Override a xs -> Override a xs -> Bool

(Generic (Override a xs), Ord (Rep (Override a xs) ())) => Ord (Override a xs)

Defined in Data.Override.Instances

Methods

compare :: Override a xs -> Override a xs -> Ordering

(<) :: Override a xs -> Override a xs -> Bool

(<=) :: Override a xs -> Override a xs -> Bool

(>) :: Override a xs -> Override a xs -> Bool

(>=) :: Override a xs -> Override a xs -> Bool

max :: Override a xs -> Override a xs -> Override a xs

min :: Override a xs -> Override a xs -> Override a xs

(Generic a, GOverride xs (Rep a)) => Generic (Override a xs)

Defined in Data.Override.Internal

Associated Types

type Rep (Override a xs) :: Type -> Type

Methods

from :: Override a xs -> Rep (Override a xs) x

to :: Rep (Override a xs) x -> Override a xs

(Generic (Override a xs), Semigroup (Rep (Override a xs) ())) => Semigroup (Override a xs)

Defined in Data.Override.Instances

Methods

(<>) :: Override a xs -> Override a xs -> Override a xs

sconcat :: NonEmpty (Override a xs) -> Override a xs

stimes :: Integral b => b -> Override a xs -> Override a xs

(Generic (Override a xs), Monoid (Rep (Override a xs) ())) => Monoid (Override a xs)

Defined in Data.Override.Instances

Methods

mempty :: Override a xs

mappend :: Override a xs -> Override a xs -> Override a xs

mconcat :: [Override a xs] -> Override a xs

type Rep (Override a xs)

Defined in Data.Override.Internal

type Rep (Override a xs) = OverrideRep xs (Rep a)

unOverride :: Override a xs -> a

Unwrap an Override value.

override :: a -> proxy xs -> Override a xs

Construct an Override using a proxy of overrides.

data As (o :: k) n

Used to construct a type-level override. Usually used infix. The o should be either a type (kind *) or a type-level string (kind Symbol).

data With (o :: k) (w :: * -> *)

Used to wrap a field into a something of kind * -> *, for example another newtype.

newtype Overridden (ms :: Maybe Symbol) a (xs :: [*])

Used at the leaf nodes of a generic Rep

Constructors

Overridden a

Instances

(Coercible a (Using ms a xs), Eq (Using ms a xs)) => Eq (Overridden ms a xs)

Defined in Data.Override.Instances

Methods

(==) :: Overridden ms a xs -> Overridden ms a xs -> Bool

(/=) :: Overridden ms a xs -> Overridden ms a xs -> Bool

(Coercible a (Using ms a xs), Ord (Using ms a xs)) => Ord (Overridden ms a xs)

Defined in Data.Override.Instances

Methods

compare :: Overridden ms a xs -> Overridden ms a xs -> Ordering

(<) :: Overridden ms a xs -> Overridden ms a xs -> Bool

(<=) :: Overridden ms a xs -> Overridden ms a xs -> Bool

(>) :: Overridden ms a xs -> Overridden ms a xs -> Bool

(>=) :: Overridden ms a xs -> Overridden ms a xs -> Bool

max :: Overridden ms a xs -> Overridden ms a xs -> Overridden ms a xs

min :: Overridden ms a xs -> Overridden ms a xs -> Overridden ms a xs

(Coercible a (Using ms a xs), Semigroup (Using ms a xs)) => Semigroup (Overridden ms a xs)

Defined in Data.Override.Instances

Methods

(<>) :: Overridden ms a xs -> Overridden ms a xs -> Overridden ms a xs

sconcat :: NonEmpty (Overridden ms a xs) -> Overridden ms a xs

stimes :: Integral b => b -> Overridden ms a xs -> Overridden ms a xs

(Coercible a (Using ms a xs), Monoid (Using ms a xs)) => Monoid (Overridden ms a xs)

Defined in Data.Override.Instances

Methods

mempty :: Overridden ms a xs

mappend :: Overridden ms a xs -> Overridden ms a xs -> Overridden ms a xs

mconcat :: [Overridden ms a xs] -> Overridden ms a xs

unOverridden :: Overridden ms a xs -> a

Unwrap an Overridden value.

overridden :: forall a (ms :: Maybe Symbol) (xs :: [*]) proxy0 proxy1. a -> proxy0 ms -> proxy1 xs -> Overridden ms a xs

Same as override but for Overridden types.

class GOverride (xs :: [*]) (f :: * -> *) where

Type class used to build the Generic instance for Override.

Associated Types

type OverrideRep xs f :: * -> *

Analogous to Rep; rewrites the type for a given Rep and injects Overridden at the leaves.

Methods

overrideFrom :: f x -> OverrideRep xs f x

overrideTo :: OverrideRep xs f x -> f x

Instances

(GOverride xs f, GOverride xs g) => GOverride xs (f :*: g)

Defined in Data.Override.Internal

Associated Types

type OverrideRep xs (f :*: g) :: Type -> Type

Methods

overrideFrom :: (f :*: g) x -> OverrideRep xs (f :*: g) x

overrideTo :: OverrideRep xs (f :*: g) x -> (f :*: g) x

GOverride xs (M1 S ('MetaSel ms su ss ds) (K1 R c :: Type -> Type))

Defined in Data.Override.Internal

Associated Types

type OverrideRep xs (M1 S ('MetaSel ms su ss ds) (K1 R c)) :: Type -> Type

Methods

overrideFrom :: M1 S ('MetaSel ms su ss ds) (K1 R c) x -> OverrideRep xs (M1 S ('MetaSel ms su ss ds) (K1 R c)) x

overrideTo :: OverrideRep xs (M1 S ('MetaSel ms su ss ds) (K1 R c)) x -> M1 S ('MetaSel ms su ss ds) (K1 R c) x

GOverride xs f => GOverride xs (M1 C c f)

Defined in Data.Override.Internal

Associated Types

type OverrideRep xs (M1 C c f) :: Type -> Type

Methods

overrideFrom :: M1 C c f x -> OverrideRep xs (M1 C c f) x

overrideTo :: OverrideRep xs (M1 C c f) x -> M1 C c f x

GOverride xs f => GOverride xs (M1 D c f)

Defined in Data.Override.Internal

Associated Types

type OverrideRep xs (M1 D c f) :: Type -> Type

Methods

overrideFrom :: M1 D c f x -> OverrideRep xs (M1 D c f) x

overrideTo :: OverrideRep xs (M1 D c f) x -> M1 D c f x

type family Using (ms :: Maybe Symbol) (x :: *) (xs :: [*]) where ...

Type family used to determine which override from xs to replace x with, if any. The ms holds the field name for x, if applicable.

Equations

Using ms x '[] = x

Using ms x (As (o :: Symbol) n ': xs) = If (ms == 'Just o) n (Using ms x xs)

Using ms x (With (o :: Symbol) w ': xs) = If (ms == 'Just o) (w x) (Using ms x xs)

Using ms x (As (o :: *) n ': xs) = If (x == o) n (Using ms x xs)

Using ms x (With (o :: *) w ': xs) = If (x == o) (w x) (Using ms x xs)