generic-data-functions-0.1.1: Familiar functions lifted to generic data types
Safe HaskellSafe-Inferred
LanguageGHC2021

Generic.Data.Function.FoldMap

Description

foldMap for generic data types.

foldMap can be considered a two-step process:

  • map every element a of a t a (where Foldable t) to some Monoid m
  • combine elements using (<>)

Applying this to generic data types:

  • map every field of a constructor to some Monoid m
  • combine elements using (<>)

Field mappings are handled using a per-monoid type class. You need a monoid m with an associated type class which has a function a -> m. Write a GenericFoldMap instance for your monoid which points to your type class. If a field type doesn't have a matching instance, the generic instance emits a type error.

Sum types (with multiple constructors) are handled by (<>)-ing the constructor with its contents (in that order). You must provide a String -> m function for mapping constructor names. If you need custom sum type handling, you may write your own and still leverage the individual constructor generics.

This function can provide generic support for simple fold-y operations like serialization.

Synopsis

Documentation

class GenericFoldMap m where Source #

Monoids that can be generically foldMapped to.

Associated Types

type GenericFoldMapC m a :: Constraint Source #

The type class that enables mapping permitted types to the monoid.

The type class should provide a function that looks like genericFoldMapF.

Methods

genericFoldMapF :: GenericFoldMapC m a => a -> m Source #

The "map" function in foldMap (first argument).

Instances

Instances details
GenericFoldMap (Showly String) Source # 
Instance details

Defined in Generic.Data.Function.Example

Associated Types

type GenericFoldMapC (Showly String) a Source #

Monoid m => GenericFoldMap (EmptyRec0 m) Source #

foldMap over types where all fields map to mempty.

Instance details

Defined in Generic.Data.Function.FoldMap.Constructor

Associated Types

type GenericFoldMapC (EmptyRec0 m) a Source #

GenericFoldMap (NoRec0 m) Source #

foldMap over types with no fields in any constructor.

Instance details

Defined in Generic.Data.Function.FoldMap.Constructor

Associated Types

type GenericFoldMapC (NoRec0 m) a Source #

genericFoldMapNonSum :: forall m a. (Generic a, GFoldMapNonSum m (Rep a)) => a -> m Source #

Generic foldMap over a term of non-sum data type a.

a must have exactly one constructor.

class GFoldMapNonSum m f Source #

foldMap over generic product data types.

Take a generic representation, map each field in the data type to a Monoid, and combine the results with (<>).

Minimal complete definition

gFoldMapNonSum

Instances

Instances details
(TypeError ENoEmpty :: Constraint) => GFoldMapNonSum m (V1 :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.NonSum

Methods

gFoldMapNonSum :: forall (p :: k0). V1 p -> m Source #

(TypeError EUnexpectedSum :: Constraint) => GFoldMapNonSum m (l :+: r :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.NonSum

Methods

gFoldMapNonSum :: forall (p :: k0). (l :+: r) p -> m Source #

GFoldMapC m f => GFoldMapNonSum m (C1 c f :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.NonSum

Methods

gFoldMapNonSum :: forall (p :: k0). C1 c f p -> m Source #

GFoldMapNonSum m f => GFoldMapNonSum m (D1 c f :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.NonSum

Methods

gFoldMapNonSum :: forall (p :: k0). D1 c f p -> m Source #

genericFoldMapSum :: forall m a. (Generic a, GFoldMapSum m (Rep a)) => (String -> m) -> a -> m Source #

Generic foldMap over a term of sum data type a.

a must have at least two constructors.

You must provide a function for mapping constructor names to monoidal values.

This is the most generic option, but depending on your string manipulation may be slower.

class GFoldMapSum m f Source #

Minimal complete definition

gFoldMapSum

Instances

Instances details
(TypeError ENoEmpty :: Constraint) => GFoldMapSum m (V1 :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.Sum

Methods

gFoldMapSum :: forall (p :: k0). (String -> m) -> V1 p -> m Source #

GFoldMapCSum m (l :+: r) => GFoldMapSum m (l :+: r :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.Sum

Methods

gFoldMapSum :: forall (p :: k0). (String -> m) -> (l :+: r) p -> m Source #

(TypeError EUnexpectedNonSum :: Constraint) => GFoldMapSum m (C1 c f :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.Sum

Methods

gFoldMapSum :: forall (p :: k0). (String -> m) -> C1 c f p -> m Source #

GFoldMapSum m f => GFoldMapSum m (D1 c f :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.Sum

Methods

gFoldMapSum :: forall (p :: k0). (String -> m) -> D1 c f p -> m Source #

genericFoldMapSumConsByte :: forall m a. (Generic a, GFoldMapSumConsByte m (Rep a)) => (Word8 -> m) -> a -> m Source #

Generic foldMap over a term of sum data type a where constructors are mapped to their index (distance from first/leftmost constructor)

a must have at least two constructors.

You must provide a function for mapping bytes to monoidal values.

This should be fairly fast, but sadly I think it's slower than the generics in store and binary/cereal libraries.

class GFoldMapSumConsByte m f Source #

Minimal complete definition

gFoldMapSumConsByte

Instances

Instances details
(TypeError ENoEmpty :: Constraint) => GFoldMapSumConsByte m (V1 :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.SumConsByte

Methods

gFoldMapSumConsByte :: forall (p :: k0). (Word8 -> m) -> V1 p -> m Source #

(FitsInByte (SumArity (l :+: r)), GFoldMapCSumCtrArityByte m 0 (l :+: r), GFoldMapCSumCtr m (l :+: r), Semigroup m) => GFoldMapSumConsByte m (l :+: r :: Type -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.SumConsByte

Methods

gFoldMapSumConsByte :: forall (p :: k). (Word8 -> m) -> (l :+: r) p -> m Source #

(TypeError EUnexpectedNonSum :: Constraint) => GFoldMapSumConsByte m (C1 c f :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.SumConsByte

Methods

gFoldMapSumConsByte :: forall (p :: k0). (Word8 -> m) -> C1 c f p -> m Source #

GFoldMapSumConsByte m f => GFoldMapSumConsByte m (D1 c f :: k -> Type) Source # 
Instance details

Defined in Generic.Data.Function.FoldMap.SumConsByte

Methods

gFoldMapSumConsByte :: forall (p :: k0). (Word8 -> m) -> D1 c f p -> m Source #