Modulederiving-compat-0.6.8Haskell2010

Data.Functor.Deriving.Internal

The machinery needed to derive Foldable, Functor, and Traversable instances.

For more info on how deriving Functor works, see this GHC wiki page.

Note: this is an internal module, and as such, the API presented here is not guaranteed to be stable, even between minor releases of this library.

1 type
29 values

Packagederiving-compat-0.6.8
Exports30
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternal.hs

Foldable

12 declarations

valuederiveFoldable :: Name -> Q [Dec]

Generates a Foldable instance declaration for the given data type or data family instance.

valuederiveFoldableOptions :: FFTOptions -> Name -> Q [Dec]

Like deriveFoldable, but takes an FFTOptions argument.

valuemakeFoldMap :: Name -> Q Exp

Generates a lambda expression which behaves like foldMap (without requiring a Foldable instance).

valuemakeFoldMapOptions :: FFTOptions -> Name -> Q Exp

Like makeFoldMap, but takes an FFTOptions argument.

valuemakeFoldr :: Name -> Q Exp

Generates a lambda expression which behaves like foldr (without requiring a Foldable instance).

valuemakeFoldrOptions :: FFTOptions -> Name -> Q Exp

Like makeFoldr, but takes an FFTOptions argument.

valuemakeFold :: Name -> Q Exp

Generates a lambda expression which behaves like fold (without requiring a Foldable instance).

valuemakeFoldOptions :: FFTOptions -> Name -> Q Exp

Like makeFold, but takes an FFTOptions argument.

valuemakeFoldl :: Name -> Q Exp

Generates a lambda expression which behaves like foldl (without requiring a Foldable instance).

valuemakeFoldlOptions :: FFTOptions -> Name -> Q Exp

Like makeFoldl, but takes an FFTOptions argument.

valuemakeNull :: Name -> Q Exp

Generates a lambda expression which behaves like null (without requiring a Foldable instance).

valuemakeNullOptions :: FFTOptions -> Name -> Q Exp

Like makeNull, but takes an FFTOptions argument.

Functor

6 declarations

valuederiveFunctor :: Name -> Q [Dec]

Generates a Functor instance declaration for the given data type or data family instance.

valuederiveFunctorOptions :: FFTOptions -> Name -> Q [Dec]

Like deriveFunctor, but takes an FFTOptions argument.

valuemakeFmap :: Name -> Q Exp

Generates a lambda expression which behaves like fmap (without requiring a Functor instance).

valuemakeFmapOptions :: FFTOptions -> Name -> Q Exp

Like makeFmap, but takes an FFTOptions argument.

valuemakeReplace :: Name -> Q Exp

Generates a lambda expression which behaves like (<$) (without requiring a Functor instance).

valuemakeReplaceOptions :: FFTOptions -> Name -> Q Exp

Like makeReplace, but takes an FFTOptions argument.

Traversable

10 declarations

valuederiveTraversable :: Name -> Q [Dec]

Generates a Traversable instance declaration for the given data type or data family instance.

valuederiveTraversableOptions :: FFTOptions -> Name -> Q [Dec]

Like deriveTraverse, but takes an FFTOptions argument.

valuemakeTraverse :: Name -> Q Exp

Generates a lambda expression which behaves like traverse (without requiring a Traversable instance).

valuemakeTraverseOptions :: FFTOptions -> Name -> Q Exp

Like makeTraverse, but takes an FFTOptions argument.

valuemakeSequenceA :: Name -> Q Exp

Generates a lambda expression which behaves like sequenceA (without requiring a Traversable instance).

valuemakeSequenceAOptions :: FFTOptions -> Name -> Q Exp

Like makeSequenceA, but takes an FFTOptions argument.

valuemakeMapM :: Name -> Q Exp

Generates a lambda expression which behaves like mapM (without requiring a Traversable instance).

valuemakeMapMOptions :: FFTOptions -> Name -> Q Exp

Like makeMapM, but takes an FFTOptions argument.

valuemakeSequence :: Name -> Q Exp

Generates a lambda expression which behaves like sequence (without requiring a Traversable instance).

valuemakeSequenceOptions :: FFTOptions -> Name -> Q Exp

Like makeSequence, but takes an FFTOptions argument.

FFTOptions

2 declarations

newtypenewtype FFTOptions

Options that further configure how the functions in Data.Functor.Deriving should behave. (FFT stands for FunctorFoldableTraversable.)

Constructors

FFTOptions
- fftEmptyCaseBehavior :: Bool
  If True, derived instances for empty data types (i.e., ones with no data constructors) will use the EmptyCase language extension. If False, derived instances will simply use seq instead. (This has no effect on GHCs before 7.8, since EmptyCase is only available in 7.8 or later.)

Instances4Eq, Ord, Read, Show

Eq FFTOptionsDefined in deriving-compat-0.6.8 · Data.Functor.Deriving.Internal
Ord FFTOptionsDefined in deriving-compat-0.6.8 · Data.Functor.Deriving.Internal
Read FFTOptionsDefined in deriving-compat-0.6.8 · Data.Functor.Deriving.Internal
Show FFTOptionsDefined in deriving-compat-0.6.8 · Data.Functor.Deriving.Internal

valuedefaultFFTOptions :: FFTOptions

Conservative FFTOptions that doesn't attempt to use EmptyCase (to prevent users from having to enable that extension at use sites.)