Add gcoerceWith to Data.Type.Coercion
authorRyan Scott <ryan.gl.scott@gmail.com>
Thu, 18 Aug 2016 13:11:03 +0000 (09:11 -0400)
committerRyan Scott <ryan.gl.scott@gmail.com>
Thu, 18 Aug 2016 13:11:03 +0000 (09:11 -0400)
Summary:
For symmetry with `gcastWith` in `Data.Type.Equality`.

Fixes #12493.

Test Plan: It compiles

Reviewers: bgamari, goldfire, hvr, austin

Subscribers: thomie

Differential Revision: https://phabricator.haskell.org/D2456

GHC Trac Issues: #12493

docs/users_guide/8.2.1-notes.rst
libraries/base/Data/Type/Coercion.hs
libraries/base/changelog.md

index 27b49ef..0126427 100644 (file)
@@ -100,6 +100,9 @@ See ``changelog.md`` in the ``base`` package for full release notes.
 
 - ``Data.Either`` now provides ``fromLeft`` and ``fromRight``
 
+- ``Data.Type.Coercion`` now provides ``gcoerceWith``, which is analogous to
+  ``gcastWith`` from ``Data.Type.Equality``.
+
 binary
 ~~~~~~
 
index 254bb9a..318d098 100644 (file)
@@ -7,6 +7,7 @@
 {-# LANGUAGE StandaloneDeriving  #-}
 {-# LANGUAGE NoImplicitPrelude   #-}
 {-# LANGUAGE PolyKinds           #-}
+{-# LANGUAGE RankNTypes          #-}
 
 -----------------------------------------------------------------------------
 -- |
@@ -25,6 +26,7 @@
 module Data.Type.Coercion
   ( Coercion(..)
   , coerceWith
+  , gcoerceWith
   , sym
   , trans
   , repr
@@ -56,6 +58,12 @@ data Coercion a b where
 coerceWith :: Coercion a b -> a -> b
 coerceWith Coercion x = coerce x
 
+-- | Generalized form of type-safe cast using representational equality
+--
+-- @since 4.10.0.0
+gcoerceWith :: Coercion a b -> (Coercible a b => r) -> r
+gcoerceWith Coercion x = x
+
 -- | Symmetry of representational equality
 sym :: Coercion a b -> Coercion b a
 sym Coercion = Coercion
index 996456f..f8f6b10 100644 (file)
@@ -16,6 +16,8 @@
 
   * `Data.Either` now provides `fromLeft` and `fromRight` (#12402)
 
+  * `Data.Type.Coercion` now provides `gcoerceWith` (#12493)
+
 ## 4.9.0.0  *May 2016*
 
   * Bundled with GHC 8.0