Generic.Data.Internal.Generically

Newtypes with instances implemented using generic combinators.

Warning

This is an internal module: it is not subject to any versioning policy, breaking changes can happen at any time.

If something here seems useful, please report it or create a pull request to export it from an external module.

Documentation

newtype Generically a

Type with instances derived via Generic.

Examples

Deriving Eq, Ord, Show, Read

>>> :set -XDerivingVia -XDeriveGeneric
>>> :{
data T = C Int Bool
  deriving Generic
  deriving (Eq, Ord, Show, Read) via (Generically T)
:}

Deriving Semigroup, Monoid

The type must have only one constructor.

>>> :{
data U = D [Int] (Sum Int)
  deriving Generic
  deriving (Semigroup, Monoid) via (Generically U)
:}

Deriving Enum, Bounded

The type must have only nullary constructors. To lift that restriction, see FiniteEnumeration.

>>> :{
data V = X | Y | Z
  deriving Generic
  deriving (Eq, Ord, Enum, Bounded) via (Generically V)
:}

Constructors

Generically

Fields

• unGenerically :: a

Instances

(Generic a, GBounded (Rep a)) => Bounded (Generically a)

Defined in Generic.Data.Internal.Generically

Methods

minBound :: Generically a

maxBound :: Generically a

(Generic a, GEnum StandardEnum (Rep a)) => Enum (Generically a)

Defined in Generic.Data.Internal.Generically

Methods

succ :: Generically a -> Generically a

pred :: Generically a -> Generically a

toEnum :: Int -> Generically a

fromEnum :: Generically a -> Int

enumFrom :: Generically a -> [Generically a]

enumFromThen :: Generically a -> Generically a -> [Generically a]

enumFromTo :: Generically a -> Generically a -> [Generically a]

enumFromThenTo :: Generically a -> Generically a -> Generically a -> [Generically a]

(Generic a, Eq (Rep a ())) => Eq (Generically a)

Defined in Generic.Data.Internal.Generically

Methods

(==) :: Generically a -> Generically a -> Bool

(/=) :: Generically a -> Generically a -> Bool

(Generic a, Ord (Rep a ())) => Ord (Generically a)

Defined in Generic.Data.Internal.Generically

Methods

compare :: Generically a -> Generically a -> Ordering

(<) :: Generically a -> Generically a -> Bool

(<=) :: Generically a -> Generically a -> Bool

(>) :: Generically a -> Generically a -> Bool

(>=) :: Generically a -> Generically a -> Bool

max :: Generically a -> Generically a -> Generically a

min :: Generically a -> Generically a -> Generically a

(Generic a, GRead0 (Rep a)) => Read (Generically a)

Defined in Generic.Data.Internal.Generically

Methods

readsPrec :: Int -> ReadS (Generically a)

readList :: ReadS [Generically a]

readPrec :: ReadPrec (Generically a)

readListPrec :: ReadPrec [Generically a]

(Generic a, GShow0 (Rep a)) => Show (Generically a)

Defined in Generic.Data.Internal.Generically

Methods

showsPrec :: Int -> Generically a -> ShowS

show :: Generically a -> String

showList :: [Generically a] -> ShowS

(Generic a, Ord (Rep a ()), GIx (Rep a)) => Ix (Generically a)

Defined in Generic.Data.Internal.Generically

Methods

range :: (Generically a, Generically a) -> [Generically a]

index :: (Generically a, Generically a) -> Generically a -> Int

unsafeIndex :: (Generically a, Generically a) -> Generically a -> Int

inRange :: (Generically a, Generically a) -> Generically a -> Bool

rangeSize :: (Generically a, Generically a) -> Int

unsafeRangeSize :: (Generically a, Generically a) -> Int

Generic a => Generic (Generically a)

Defined in Generic.Data.Internal.Generically

Associated Types

type Rep (Generically a) :: Type -> Type

Methods

from :: Generically a -> Rep (Generically a) x

to :: Rep (Generically a) x -> Generically a

(AssertNoSum Semigroup a, Generic a, Semigroup (Rep a ())) => Semigroup (Generically a)

Defined in Generic.Data.Internal.Generically

Methods

(<>) :: Generically a -> Generically a -> Generically a

sconcat :: NonEmpty (Generically a) -> Generically a

stimes :: Integral b => b -> Generically a -> Generically a

(AssertNoSum Semigroup a, Semigroup a, Generic a, Monoid (Rep a ())) => Monoid (Generically a)

This uses the Semigroup instance of the wrapped type a to define mappend. The purpose of this instance is to derive mempty, while remaining consistent with possibly custom Semigroup instances.

Defined in Generic.Data.Internal.Generically

Methods

mempty :: Generically a

mappend :: Generically a -> Generically a -> Generically a

mconcat :: [Generically a] -> Generically a

type Rep (Generically a)

Defined in Generic.Data.Internal.Generically

type Rep (Generically a) = Rep a

newtype FiniteEnumeration a

Type with Enum instance derived via Generic with FiniteEnum option. This allows deriving Enum for types whose constructors have fields.

Some caution is advised; see details in FiniteEnum.

Example

>>> :{
data Booool = Booool Bool Bool
  deriving Generic
  deriving (Enum, Bounded) via (FiniteEnumeration Booool)
:}

Constructors

FiniteEnumeration

Fields

• unFiniteEnumeration :: a

Instances

(Generic a, GBounded (Rep a)) => Bounded (FiniteEnumeration a)

The same instance as Generically, for convenience.

Defined in Generic.Data.Internal.Generically

Methods

minBound :: FiniteEnumeration a

maxBound :: FiniteEnumeration a

(Generic a, GEnum FiniteEnum (Rep a)) => Enum (FiniteEnumeration a)

Defined in Generic.Data.Internal.Generically

Methods

succ :: FiniteEnumeration a -> FiniteEnumeration a

pred :: FiniteEnumeration a -> FiniteEnumeration a

toEnum :: Int -> FiniteEnumeration a

fromEnum :: FiniteEnumeration a -> Int

enumFrom :: FiniteEnumeration a -> [FiniteEnumeration a]

enumFromThen :: FiniteEnumeration a -> FiniteEnumeration a -> [FiniteEnumeration a]

enumFromTo :: FiniteEnumeration a -> FiniteEnumeration a -> [FiniteEnumeration a]

enumFromThenTo :: FiniteEnumeration a -> FiniteEnumeration a -> FiniteEnumeration a -> [FiniteEnumeration a]

Generic a => Generic (FiniteEnumeration a)

Defined in Generic.Data.Internal.Generically

Associated Types

type Rep (FiniteEnumeration a) :: Type -> Type

Methods

from :: FiniteEnumeration a -> Rep (FiniteEnumeration a) x

to :: Rep (FiniteEnumeration a) x -> FiniteEnumeration a

type Rep (FiniteEnumeration a)

Defined in Generic.Data.Internal.Generically

type Rep (FiniteEnumeration a) = Rep a

newtype Generically1 f a

Type with instances derived via Generic1.

Examples

Deriving Functor, Applicative, Alternative

Applicative can be derived for types with only one constructor, aka. products.

>>> :{
data F a = F1 a | F2 (Maybe a) | F3 [Either Bool a] (Int, a)
  deriving Generic1
  deriving Functor via (Generically1 F)
:}

>>> :{
data G a = G a (Maybe a) [a] (IO a)
  deriving Generic1
  deriving (Functor, Applicative) via (Generically1 G)
:}

>>> :{
data G' a = G' (Maybe a) [a]
  deriving Generic1
  deriving (Functor, Applicative, Alternative) via (Generically1 G')
:}

Deriving Foldable

>>> import Generic.Data.Orphans ()
>>> :{
data H a = H1 a | H2 (Maybe a)
  deriving Generic1
  deriving (Functor, Foldable) via (Generically1 H)
:}

Note: we can't use DerivingVia for Traversable. One may implement Traversable explicitly using gtraverse.

Deriving Eq1, Ord1

>>> :{
data I a = I [a] (Maybe a)
  deriving Generic1
  deriving (Eq1, Ord1) via (Generically1 I)
:}

Constructors

Generically1

Fields

• unGenerically1 :: f a

Instances

(Generic1 f, Functor (Rep1 f)) => Functor (Generically1 f)

Defined in Generic.Data.Internal.Generically

Methods

fmap :: (a -> b) -> Generically1 f a -> Generically1 f b

(<$) :: a -> Generically1 f b -> Generically1 f a

(Generic1 f, Applicative (Rep1 f)) => Applicative (Generically1 f)

Defined in Generic.Data.Internal.Generically

Methods

pure :: a -> Generically1 f a

(<*>) :: Generically1 f (a -> b) -> Generically1 f a -> Generically1 f b

liftA2 :: (a -> b -> c) -> Generically1 f a -> Generically1 f b -> Generically1 f c

(*>) :: Generically1 f a -> Generically1 f b -> Generically1 f b

(<*) :: Generically1 f a -> Generically1 f b -> Generically1 f a

(Generic1 f, GFoldable (Rep1 f)) => Foldable (Generically1 f)

Defined in Generic.Data.Internal.Generically

Methods

fold :: Monoid m => Generically1 f m -> m

foldMap :: Monoid m => (a -> m) -> Generically1 f a -> m

foldMap' :: Monoid m => (a -> m) -> Generically1 f a -> m

foldr :: (a -> b -> b) -> b -> Generically1 f a -> b

foldr' :: (a -> b -> b) -> b -> Generically1 f a -> b

foldl :: (b -> a -> b) -> b -> Generically1 f a -> b

foldl' :: (b -> a -> b) -> b -> Generically1 f a -> b

foldr1 :: (a -> a -> a) -> Generically1 f a -> a

foldl1 :: (a -> a -> a) -> Generically1 f a -> a

toList :: Generically1 f a -> [a]

null :: Generically1 f a -> Bool

length :: Generically1 f a -> Int

elem :: Eq a => a -> Generically1 f a -> Bool

maximum :: Ord a => Generically1 f a -> a

minimum :: Ord a => Generically1 f a -> a

sum :: Num a => Generically1 f a -> a

product :: Num a => Generically1 f a -> a

(Generic1 f, Functor (Rep1 f), GFoldable (Rep1 f), GTraversable (Rep1 f)) => Traversable (Generically1 f)

Defined in Generic.Data.Internal.Generically

Methods

traverse :: Applicative f0 => (a -> f0 b) -> Generically1 f a -> f0 (Generically1 f b)

sequenceA :: Applicative f0 => Generically1 f (f0 a) -> f0 (Generically1 f a)

mapM :: Monad m => (a -> m b) -> Generically1 f a -> m (Generically1 f b)

sequence :: Monad m => Generically1 f (m a) -> m (Generically1 f a)

(Generic1 f, Eq1 (Rep1 f)) => Eq1 (Generically1 f)

Defined in Generic.Data.Internal.Generically

Methods

liftEq :: (a -> b -> Bool) -> Generically1 f a -> Generically1 f b -> Bool

(Generic1 f, Ord1 (Rep1 f)) => Ord1 (Generically1 f)

Defined in Generic.Data.Internal.Generically

Methods

liftCompare :: (a -> b -> Ordering) -> Generically1 f a -> Generically1 f b -> Ordering

(Generic1 f, GRead1 (Rep1 f)) => Read1 (Generically1 f)

Defined in Generic.Data.Internal.Generically

Methods

liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (Generically1 f a)

liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [Generically1 f a]

liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (Generically1 f a)

liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [Generically1 f a]

(Generic1 f, GShow1 (Rep1 f)) => Show1 (Generically1 f)

Defined in Generic.Data.Internal.Generically

Methods

liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> Generically1 f a -> ShowS

liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [Generically1 f a] -> ShowS

(Generic1 f, Alternative (Rep1 f)) => Alternative (Generically1 f)

Defined in Generic.Data.Internal.Generically

Methods

empty :: Generically1 f a

(<|>) :: Generically1 f a -> Generically1 f a -> Generically1 f a

some :: Generically1 f a -> Generically1 f [a]

many :: Generically1 f a -> Generically1 f [a]

Generic1 f => Generic1 (Generically1 f :: Type -> Type)

Defined in Generic.Data.Internal.Generically

Associated Types

type Rep1 (Generically1 f) :: k -> Type

Methods

from1 :: forall (a :: k). Generically1 f a -> Rep1 (Generically1 f) a

to1 :: forall (a :: k). Rep1 (Generically1 f) a -> Generically1 f a

(Generic1 f, Eq1 (Rep1 f), Eq a) => Eq (Generically1 f a)

Defined in Generic.Data.Internal.Generically

Methods

(==) :: Generically1 f a -> Generically1 f a -> Bool

(/=) :: Generically1 f a -> Generically1 f a -> Bool

(Generic1 f, Ord1 (Rep1 f), Ord a) => Ord (Generically1 f a)

Defined in Generic.Data.Internal.Generically

Methods

compare :: Generically1 f a -> Generically1 f a -> Ordering

(<) :: Generically1 f a -> Generically1 f a -> Bool

(<=) :: Generically1 f a -> Generically1 f a -> Bool

(>) :: Generically1 f a -> Generically1 f a -> Bool

(>=) :: Generically1 f a -> Generically1 f a -> Bool

max :: Generically1 f a -> Generically1 f a -> Generically1 f a

min :: Generically1 f a -> Generically1 f a -> Generically1 f a

(Generic1 f, GRead1 (Rep1 f), Read a) => Read (Generically1 f a)

Defined in Generic.Data.Internal.Generically

Methods

readsPrec :: Int -> ReadS (Generically1 f a)

readList :: ReadS [Generically1 f a]

readPrec :: ReadPrec (Generically1 f a)

readListPrec :: ReadPrec [Generically1 f a]

(Generic1 f, GShow1 (Rep1 f), Show a) => Show (Generically1 f a)

Defined in Generic.Data.Internal.Generically

Methods

showsPrec :: Int -> Generically1 f a -> ShowS

show :: Generically1 f a -> String

showList :: [Generically1 f a] -> ShowS

Generic (f a) => Generic (Generically1 f a)

Defined in Generic.Data.Internal.Generically

Associated Types

type Rep (Generically1 f a) :: Type -> Type

Methods

from :: Generically1 f a -> Rep (Generically1 f a) x

to :: Rep (Generically1 f a) x -> Generically1 f a

type Rep1 (Generically1 f :: Type -> Type)

Defined in Generic.Data.Internal.Generically

type Rep1 (Generically1 f :: Type -> Type) = Rep1 f

type Rep (Generically1 f a)

Defined in Generic.Data.Internal.Generically

type Rep (Generically1 f a) = Rep (f a)

newtype GenericProduct a

Product type with generic instances of Semigroup and Monoid.

This is similar to Generically in most cases, but GenericProduct also works for types T with deriving via GenericProduct U, where U is a generic product type coercible to, but distinct from T. In particular, U may not have an instance of Semigroup, which Generically requires.

Example

>>> :set -XDeriveGeneric -XDerivingVia
>>> data Point a = Point a a deriving Generic
>>> :{
  newtype Vector a = Vector (Point a)
    deriving (Semigroup, Monoid)
      via GenericProduct (Point (Sum a))
:}

If it were via Generically (Point (Sum a)) instead, then Vector's mappend (the Monoid method) would be defined as Point's (<>) (the Semigroup method), which might not exist, or might not be equivalent to Vector's generic Semigroup instance, which would be unlawful.

Constructors

GenericProduct

Fields

• unGenericProduct :: a

Instances

Generic a => Generic (GenericProduct a)

Defined in Generic.Data.Internal.Generically

Associated Types

type Rep (GenericProduct a) :: Type -> Type

Methods

from :: GenericProduct a -> Rep (GenericProduct a) x

to :: Rep (GenericProduct a) x -> GenericProduct a

(AssertNoSum Semigroup a, Generic a, Semigroup (Rep a ())) => Semigroup (GenericProduct a)

Defined in Generic.Data.Internal.Generically

Methods

(<>) :: GenericProduct a -> GenericProduct a -> GenericProduct a

sconcat :: NonEmpty (GenericProduct a) -> GenericProduct a

stimes :: Integral b => b -> GenericProduct a -> GenericProduct a

(AssertNoSum Semigroup a, Generic a, Monoid (Rep a ())) => Monoid (GenericProduct a)

Defined in Generic.Data.Internal.Generically

Methods

mempty :: GenericProduct a

mappend :: GenericProduct a -> GenericProduct a -> GenericProduct a

mconcat :: [GenericProduct a] -> GenericProduct a

type Rep (GenericProduct a)

Defined in Generic.Data.Internal.Generically

type Rep (GenericProduct a) = Rep a