ByOtherNames

This package provides the general mechanism for defining field and branch aliases for algebraic datatypes.

Aliases can be defined for multiple contexts (json serialization, orms...). Each of those contexts is termed a Rubric, basically a marker datakind used to namespace the aliases.

This module should only be imported if you want to define your own adapter package for some new Rubric. See ByOtherNames.Aeson for a concrete example.

Aliases

data Aliases rep a

This datatype carries the field aliases and matches the structure of the generic Rep' shape.

Instances

FunctorWithIndex String (Aliases rep)

Indexed by the field or branch names.

Defined in ByOtherNames.Internal

Methods

imap :: (String -> a -> b) -> Aliases rep a -> Aliases rep b

FoldableWithIndex String (Aliases rep)

Defined in ByOtherNames.Internal

Methods

ifoldMap :: Monoid m => (String -> a -> m) -> Aliases rep a -> m

ifoldMap' :: Monoid m => (String -> a -> m) -> Aliases rep a -> m

ifoldr :: (String -> a -> b -> b) -> b -> Aliases rep a -> b

ifoldl :: (String -> b -> a -> b) -> b -> Aliases rep a -> b

ifoldr' :: (String -> a -> b -> b) -> b -> Aliases rep a -> b

ifoldl' :: (String -> b -> a -> b) -> b -> Aliases rep a -> b

TraversableWithIndex String (Aliases rep)

Defined in ByOtherNames.Internal

Methods

itraverse :: Applicative f => (String -> a -> f b) -> Aliases rep a -> f (Aliases rep b)

Functor (Aliases rep)

Defined in ByOtherNames.Internal

Methods

fmap :: (a -> b) -> Aliases rep a -> Aliases rep b

(<$) :: a -> Aliases rep b -> Aliases rep a

Foldable (Aliases rep)

Defined in ByOtherNames.Internal

Methods

fold :: Monoid m => Aliases rep m -> m

foldMap :: Monoid m => (a -> m) -> Aliases rep a -> m

foldMap' :: Monoid m => (a -> m) -> Aliases rep a -> m

foldr :: (a -> b -> b) -> b -> Aliases rep a -> b

foldr' :: (a -> b -> b) -> b -> Aliases rep a -> b

foldl :: (b -> a -> b) -> b -> Aliases rep a -> b

foldl' :: (b -> a -> b) -> b -> Aliases rep a -> b

foldr1 :: (a -> a -> a) -> Aliases rep a -> a

foldl1 :: (a -> a -> a) -> Aliases rep a -> a

toList :: Aliases rep a -> [a]

null :: Aliases rep a -> Bool

length :: Aliases rep a -> Int

elem :: Eq a => a -> Aliases rep a -> Bool

maximum :: Ord a => Aliases rep a -> a

minimum :: Ord a => Aliases rep a -> a

sum :: Num a => Aliases rep a -> a

product :: Num a => Aliases rep a -> a

Traversable (Aliases rep)

Defined in ByOtherNames.Internal

Methods

traverse :: Applicative f => (a -> f b) -> Aliases rep a -> f (Aliases rep b)

sequenceA :: Applicative f => Aliases rep (f a) -> f (Aliases rep a)

mapM :: Monad m => (a -> m b) -> Aliases rep a -> m (Aliases rep b)

sequence :: Monad m => Aliases rep (m a) -> m (Aliases rep a)

zipAliasesWith :: (a -> b -> c) -> Aliases rep a -> Aliases rep b -> Aliases rep c

data AliasList names a

An intermediate datatype for specifying the aliases. See aliasListBegin, alias and aliasListEnd.

aliasListBegin :: forall before a tree. AliasTree before tree '[] => AliasList before a -> Aliases tree a

Define the aliases for a type by listing them.

See also alias and aliasListEnd.

alias :: forall name a names. a -> AliasList names a -> AliasList (name ': names) a

Add an alias to an AliasList.

TYPE APPLICATION REQUIRED! You must provide the field/branch name using a type application.

aliasListEnd :: AliasList '[] a

The empty AliasList.

Rubrics

class Rubric k

Typeclass for marker datakinds used as rubrics, for classifying aliases according to their use.

The associated type family AliasType gives the type of the aliases.

Rubrics are needed when defining helper newtypes for use with -XDerivingVia. Because Aliases are defined at the value level, we need a way to relate the aliases with the datatype during deriving.

Associated Types

type AliasType k :: Type

Instances

Rubric 'JSON

The aliases will be of type Data.Aeson.Key.

Defined in ByOtherNames.Aeson

Associated Types

type AliasType 'JSON

class (Rubric k, Generic r) => Aliased k r where

Typeclass for datatypes r that have aliases for some Rubric k.

Methods

aliases :: Aliases (Rep r) (AliasType k)

Generic helpers

class GHasDatatypeName rep where

Methods

gGetDatatypeName :: String

Instances

KnownSymbol datatypeName => GHasDatatypeName (D1 ('MetaData datatypeName m p nt) (C1 y prod) :: k -> Type)

Defined in ByOtherNames.Internal

Methods

gGetDatatypeName :: String

class GHasFieldNames rep where

Methods

gGetFieldNames :: Aliases rep String

Instances

(GHasFieldNames left, GHasFieldNames right) => GHasFieldNames (left :*: right)

Defined in ByOtherNames.Internal

Methods

gGetFieldNames :: Aliases (left :*: right) String

GHasFieldNames prod => GHasFieldNames (D1 x (C1 y prod))

Defined in ByOtherNames.Internal

Methods

gGetFieldNames :: Aliases (D1 x (C1 y prod)) String

KnownSymbol fieldName => GHasFieldNames (S1 ('MetaSel ('Just fieldName) unpackedness strictness laziness) (Rec0 v))

Defined in ByOtherNames.Internal

Methods

gGetFieldNames :: Aliases (S1 ('MetaSel ('Just fieldName) unpackedness strictness laziness) (Rec0 v)) String

class GRecord (c :: Type -> Constraint) rep where

Methods

gToRecord :: Applicative m => Aliases rep a -> (forall v. c v => a -> m v) -> m (rep z)

gFromRecord :: Aliases rep a -> (forall v. c v => a -> v -> o) -> rep z -> Aliases rep o

gRecordEnum :: Aliases rep a -> (forall v. c v => Proxy v -> o) -> Aliases rep (a, o)

Instances

(GRecord c left, GRecord c right) => GRecord c (left :*: right)

Defined in ByOtherNames.Internal

Methods

gToRecord :: Applicative m => Aliases (left :*: right) a -> (forall v. c v => a -> m v) -> m ((left :*: right) z)

gFromRecord :: Aliases (left :*: right) a -> (forall v. c v => a -> v -> o) -> (left :*: right) z -> Aliases (left :*: right) o

gRecordEnum :: Aliases (left :*: right) a -> (forall v. c v => Proxy v -> o) -> Aliases (left :*: right) (a, o)

c v => GRecord c (S1 x (Rec0 v))

Defined in ByOtherNames.Internal

Methods

gToRecord :: Applicative m => Aliases (S1 x (Rec0 v)) a -> (forall v0. c v0 => a -> m v0) -> m (S1 x (Rec0 v) z)

gFromRecord :: Aliases (S1 x (Rec0 v)) a -> (forall v0. c v0 => a -> v0 -> o) -> S1 x (Rec0 v) z -> Aliases (S1 x (Rec0 v)) o

gRecordEnum :: Aliases (S1 x (Rec0 v)) a -> (forall v0. c v0 => Proxy v0 -> o) -> Aliases (S1 x (Rec0 v)) (a, o)

GRecord c prod => GRecord c (D1 x (C1 y prod))

Defined in ByOtherNames.Internal

Methods

gToRecord :: Applicative m => Aliases (D1 x (C1 y prod)) a -> (forall v. c v => a -> m v) -> m (D1 x (C1 y prod) z)

gFromRecord :: Aliases (D1 x (C1 y prod)) a -> (forall v. c v => a -> v -> o) -> D1 x (C1 y prod) z -> Aliases (D1 x (C1 y prod)) o

gRecordEnum :: Aliases (D1 x (C1 y prod)) a -> (forall v. c v => Proxy v -> o) -> Aliases (D1 x (C1 y prod)) (a, o)

class GHasBranchNames rep where

Methods

gGetBranchNames :: Aliases rep String

Instances

(GHasBranchNames left, GHasBranchNames right) => GHasBranchNames (left :+: right)

Defined in ByOtherNames.Internal

Methods

gGetBranchNames :: Aliases (left :+: right) String

GHasBranchNames (left :+: right) => GHasBranchNames (D1 x (left :+: right))

Defined in ByOtherNames.Internal

Methods

gGetBranchNames :: Aliases (D1 x (left :+: right)) String

KnownSymbol branchName => GHasBranchNames (C1 ('MetaCons branchName fixity sels) y)

Defined in ByOtherNames.Internal

Methods

gGetBranchNames :: Aliases (C1 ('MetaCons branchName fixity sels) y) String

class GSum (c :: Type -> Constraint) rep where

Methods

gToSum :: (Functor n, Applicative m2) => Aliases rep a -> (forall b. a -> Slots m1 m2 b -> n b) -> (forall v. c v => m1 v) -> (forall v. c v => m2 v) -> Aliases rep (n (rep z))

gFromSum :: Aliases rep a -> (forall v. c v => v -> o) -> rep z -> (a, [o])

gSumEnum :: Aliases rep a -> (forall v. c v => Proxy v -> o) -> Aliases rep (a, [o])

Instances

GSumSlots c (left :*: right) => GSum c (C1 x (left :*: right))

Defined in ByOtherNames.Internal

Methods

gToSum :: (Functor n, Applicative m2) => Aliases (C1 x (left :*: right)) a -> (forall b. a -> Slots m1 m2 b -> n b) -> (forall v. c v => m1 v) -> (forall v. c v => m2 v) -> Aliases (C1 x (left :*: right)) (n (C1 x (left :*: right) z))

gFromSum :: Aliases (C1 x (left :*: right)) a -> (forall v. c v => v -> o) -> C1 x (left :*: right) z -> (a, [o])

gSumEnum :: Aliases (C1 x (left :*: right)) a -> (forall v. c v => Proxy v -> o) -> Aliases (C1 x (left :*: right)) (a, [o])

c v => GSum c (C1 x (S1 y (Rec0 v)))

Defined in ByOtherNames.Internal

Methods

gToSum :: (Functor n, Applicative m2) => Aliases (C1 x (S1 y (Rec0 v))) a -> (forall b. a -> Slots m1 m2 b -> n b) -> (forall v0. c v0 => m1 v0) -> (forall v1. c v1 => m2 v1) -> Aliases (C1 x (S1 y (Rec0 v))) (n (C1 x (S1 y (Rec0 v)) z))

gFromSum :: Aliases (C1 x (S1 y (Rec0 v))) a -> (forall v0. c v0 => v0 -> o) -> C1 x (S1 y (Rec0 v)) z -> (a, [o])

gSumEnum :: Aliases (C1 x (S1 y (Rec0 v))) a -> (forall v0. c v0 => Proxy v0 -> o) -> Aliases (C1 x (S1 y (Rec0 v))) (a, [o])

GSum c (C1 x (U1 :: Type -> Type))

Defined in ByOtherNames.Internal

Methods

gToSum :: (Functor n, Applicative m2) => Aliases (C1 x U1) a -> (forall b. a -> Slots m1 m2 b -> n b) -> (forall v. c v => m1 v) -> (forall v. c v => m2 v) -> Aliases (C1 x U1) (n (C1 x U1 z))

gFromSum :: Aliases (C1 x U1) a -> (forall v. c v => v -> o) -> C1 x U1 z -> (a, [o])

gSumEnum :: Aliases (C1 x U1) a -> (forall v. c v => Proxy v -> o) -> Aliases (C1 x U1) (a, [o])

(GSum c left, GSum c right) => GSum c (left :+: right)

Defined in ByOtherNames.Internal

Methods

gToSum :: (Functor n, Applicative m2) => Aliases (left :+: right) a -> (forall b. a -> Slots m1 m2 b -> n b) -> (forall v. c v => m1 v) -> (forall v. c v => m2 v) -> Aliases (left :+: right) (n ((left :+: right) z))

gFromSum :: Aliases (left :+: right) a -> (forall v. c v => v -> o) -> (left :+: right) z -> (a, [o])

gSumEnum :: Aliases (left :+: right) a -> (forall v. c v => Proxy v -> o) -> Aliases (left :+: right) (a, [o])

GSum c (left :+: right) => GSum c (D1 x (left :+: right))

Defined in ByOtherNames.Internal

Methods

gToSum :: (Functor n, Applicative m2) => Aliases (D1 x (left :+: right)) a -> (forall b. a -> Slots m1 m2 b -> n b) -> (forall v. c v => m1 v) -> (forall v. c v => m2 v) -> Aliases (D1 x (left :+: right)) (n (D1 x (left :+: right) z))

gFromSum :: Aliases (D1 x (left :+: right)) a -> (forall v. c v => v -> o) -> D1 x (left :+: right) z -> (a, [o])

gSumEnum :: Aliases (D1 x (left :+: right)) a -> (forall v. c v => Proxy v -> o) -> Aliases (D1 x (left :+: right)) (a, [o])

data Slots m1 m2 v

Constructors

ZeroSlots v

SingleSlot (m1 v)

ManySlots (m2 v)

Instances

(Functor m1, Functor m2) => Functor (Slots m1 m2)

Defined in ByOtherNames.Internal

Methods

fmap :: (a -> b) -> Slots m1 m2 a -> Slots m1 m2 b

(<$) :: a -> Slots m1 m2 b -> Slots m1 m2 a

(Show v, Show (m1 v), Show (m2 v)) => Show (Slots m1 m2 v)

Defined in ByOtherNames.Internal

Methods

showsPrec :: Int -> Slots m1 m2 v -> ShowS

show :: Slots m1 m2 v -> String

showList :: [Slots m1 m2 v] -> ShowS

Re-exports

data Symbol

(Kind) This is the kind of type-level symbols. Declared here because class IP needs it

Instances

SingKind Symbol

Since: base-4.9.0.0

Defined in GHC.Generics

Associated Types

type DemoteRep Symbol

Methods

fromSing :: forall (a :: Symbol). Sing a -> DemoteRep Symbol

KnownSymbol a => SingI (a :: Symbol)

Since: base-4.9.0.0

Defined in GHC.Generics

Methods

sing :: Sing a

KnownSymbol fieldName => GHasFieldNames (S1 ('MetaSel ('Just fieldName) unpackedness strictness laziness) (Rec0 v))

Defined in ByOtherNames.Internal

Methods

gGetFieldNames :: Aliases (S1 ('MetaSel ('Just fieldName) unpackedness strictness laziness) (Rec0 v)) String

IsRecord (M1 S ('MetaSel ('Nothing :: Maybe Symbol) u ss ds) f) False

Defined in Data.Aeson.Types.Generic

type DemoteRep Symbol

Defined in GHC.Generics

type DemoteRep Symbol = String

data Sing (s :: Symbol)

Defined in GHC.Generics

data Sing (s :: Symbol) where

• SSym :: forall (s :: Symbol). KnownSymbol s => Sing s