newtype-generics: A typeclass and set of functions for working with newtypes, with generics support.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

Warnings:

Per Conor McBride, the Newtype typeclass represents the packing and unpacking of a newtype, and allows you to operate under that newtype with functions such as ala. Generics support was added in version 0.4, making this package a full replacement for the original newtype package, and a better alternative to newtype-th.


[Skip to ReadMe]

Properties

Versions0.4, 0.4.0.1, 0.4.1, 0.4.2, 0.5, 0.5.0.1, 0.5.1, 0.5.2, 0.5.2.1, 0.5.2.2, 0.5.2.2, 0.5.3
Change logCHANGELOG.md
Dependenciesbase (>=4.6 && <4.13), transformers (<0.6) [details]
LicenseBSD-3-Clause
AuthorDarius Jahandarie, Conor McBride, João Cristóvão, Simon Jakobi
MaintainerSimon Jakobi <simon.jakobi@gmail.com>
CategoryControl
Source repositoryhead: git clone https://github.com/jcristovao/newtype-generics
UploadedFri Mar 16 19:38:02 UTC 2018 by sjakobi

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for newtype-generics-0.5.2.2

[back to package description]

newtype-generics

A typeclass and set of functions for working with newtypes. Fork of the code published by Darius Jahandarie here, with the addition of generics.

The 'Newtype' typeclass and related functions: op, ala, ala', under. Primarly pulled from Conor McBride's Epigram work. Some examples:

-- foldMaps the list ala the Sum newtype. This results in 10.
ala Sum foldMap [1,2,3,4] 

-- foldMaps the list ala the Product newtype. This results in 24.
ala Product foldMap [1,2,3,4] 

-- foldMaps the list ala the Endo newtype. This results in 8.
ala Endo foldMap [(+1), (+2), (subtract 1), (*2)] 3 

NB: Data.Foldable.foldMap is a generalized mconcatMap which is a generalized concatMap.

This package includes Newtype instances for all the (non-GHC/foreign) newtypes in base (as seen in the examples). However, there are neat things you can do with this with /any/ newtype and you should definitely define your own 'Newtype' instances for the power of this library. For example, see ala Cont traverse, with the proper Newtype instance for Cont.

This could of course be eased with the addition of generics for version 0.3:

{-# LANGUAGE DeriveGeneric              #-}

import GHC.Generics
(...)
newtype Example = Example Int (deriving Generic)
instance Newtype Example