effectful-st (empty) → 0.0.0.0

raw patch · 5 files changed

+326/−0 lines, 5 filesdep +basedep +effectful-coredep +primitive

Dependencies added: base, effectful-core, primitive

Files

• CC0-1.0.txt +121/−0
• CHANGELOG.md +5/−0
• README.md +40/−0
• effectful-st.cabal +58/−0
• src/Effectful/ST.hs +102/−0

@@ -0,0 +1,121 @@+Creative Commons Legal Code++CC0 1.0 Universal++    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED+    HEREUNDER.++Statement of Purpose++The laws of most jurisdictions throughout the world automatically confer+exclusive Copyright and Related Rights (defined below) upon the creator+and subsequent owner(s) (each and all, an "owner") of an original work of+authorship and/or a database (each, a "Work").++Certain owners wish to permanently relinquish those rights to a Work for+the purpose of contributing to a commons of creative, cultural and+scientific works ("Commons") that the public can reliably and without fear+of later claims of infringement build upon, modify, incorporate in other+works, reuse and redistribute as freely as possible in any form whatsoever+and for any purposes, including without limitation commercial purposes.+These owners may contribute to the Commons to promote the ideal of a free+culture and the further production of creative, cultural and scientific+works, or to gain reputation or greater distribution for their Work in+part through the use and efforts of others.++For these and/or other purposes and motivations, and without any+expectation of additional consideration or compensation, the person+associating CC0 with a Work (the "Affirmer"), to the extent that he or she+is an owner of Copyright and Related Rights in the Work, voluntarily+elects to apply CC0 to the Work and publicly distribute the Work under its+terms, with knowledge of his or her Copyright and Related Rights in the+Work and the meaning and intended legal effect of CC0 on those rights.++1. Copyright and Related Rights. A Work made available under CC0 may be+protected by copyright and related or neighboring rights ("Copyright and+Related Rights"). Copyright and Related Rights include, but are not+limited to, the following:++  i. the right to reproduce, adapt, distribute, perform, display,+     communicate, and translate a Work;+ ii. moral rights retained by the original author(s) and/or performer(s);+iii. publicity and privacy rights pertaining to a person's image or+     likeness depicted in a Work;+ iv. rights protecting against unfair competition in regards to a Work,+     subject to the limitations in paragraph 4(a), below;+  v. rights protecting the extraction, dissemination, use and reuse of data+     in a Work;+ vi. database rights (such as those arising under Directive 96/9/EC of the+     European Parliament and of the Council of 11 March 1996 on the legal+     protection of databases, and under any national implementation+     thereof, including any amended or successor version of such+     directive); and+vii. other similar, equivalent or corresponding rights throughout the+     world based on applicable law or treaty, and any national+     implementations thereof.++2. Waiver. To the greatest extent permitted by, but not in contravention+of, applicable law, Affirmer hereby overtly, fully, permanently,+irrevocably and unconditionally waives, abandons, and surrenders all of+Affirmer's Copyright and Related Rights and associated claims and causes+of action, whether now known or unknown (including existing as well as+future claims and causes of action), in the Work (i) in all territories+worldwide, (ii) for the maximum duration provided by applicable law or+treaty (including future time extensions), (iii) in any current or future+medium and for any number of copies, and (iv) for any purpose whatsoever,+including without limitation commercial, advertising or promotional+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each+member of the public at large and to the detriment of Affirmer's heirs and+successors, fully intending that such Waiver shall not be subject to+revocation, rescission, cancellation, termination, or any other legal or+equitable action to disrupt the quiet enjoyment of the Work by the public+as contemplated by Affirmer's express Statement of Purpose.++3. Public License Fallback. Should any part of the Waiver for any reason+be judged legally invalid or ineffective under applicable law, then the+Waiver shall be preserved to the maximum extent permitted taking into+account Affirmer's express Statement of Purpose. In addition, to the+extent the Waiver is so judged Affirmer hereby grants to each affected+person a royalty-free, non transferable, non sublicensable, non exclusive,+irrevocable and unconditional license to exercise Affirmer's Copyright and+Related Rights in the Work (i) in all territories worldwide, (ii) for the+maximum duration provided by applicable law or treaty (including future+time extensions), (iii) in any current or future medium and for any number+of copies, and (iv) for any purpose whatsoever, including without+limitation commercial, advertising or promotional purposes (the+"License"). The License shall be deemed effective as of the date CC0 was+applied by Affirmer to the Work. Should any part of the License for any+reason be judged legally invalid or ineffective under applicable law, such+partial invalidity or ineffectiveness shall not invalidate the remainder+of the License, and in such case Affirmer hereby affirms that he or she+will not (i) exercise any of his or her remaining Copyright and Related+Rights in the Work or (ii) assert any associated claims and causes of+action with respect to the Work, in either case contrary to Affirmer's+express Statement of Purpose.++4. Limitations and Disclaimers.++ a. No trademark or patent rights held by Affirmer are waived, abandoned,+    surrendered, licensed or otherwise affected by this document.+ b. Affirmer offers the Work as-is and makes no representations or+    warranties of any kind concerning the Work, express, implied,+    statutory or otherwise, including without limitation warranties of+    title, merchantability, fitness for a particular purpose, non+    infringement, or the absence of latent or other defects, accuracy, or+    the present or absence of errors, whether or not discoverable, all to+    the greatest extent permissible under applicable law.+ c. Affirmer disclaims responsibility for clearing rights of other persons+    that may apply to the Work or any use thereof, including without+    limitation any person's Copyright and Related Rights in the Work.+    Further, Affirmer disclaims responsibility for obtaining any necessary+    consents, permissions or other rights required for any use of the+    Work.+ d. Affirmer understands and acknowledges that Creative Commons is not a+    party to this document and has no duty or obligation with respect to+    this CC0 or use of the Work.

@@ -0,0 +1,5 @@+# Revision history for effectful-st++## 0.0.0.0 -- 2022-09-06++* First version. Released on an unsuspecting world.

@@ -0,0 +1,40 @@+# `effectful-st`++Version 0.0.0.0++## Description++An [`ST`]-style alternative to the [`Prim`] effect in [`effectful`] that+allows safely running scoped state transformations without `IOE`.++The `Prim` effect allows the use of [`PrimMonad`] on `Eff` without+allowing arbitrary `IO`. However, there is no safe way to run the+effect without introducing the `IOE` effect because `Prim` has no+way of delimiting the scope of the mutation to `runPrim`. In other+words, `Prim` is effectively acting merely as a restricted form of+`IOE` that only allows `PrimMonad`.++`STE` from this package on the other hand borrows the quantification+trick from [`Control.Monad.ST`][`ST`] to provide a safe way to run+the effect purely.++This project follows the [Haskell Package Versioning Policy][PVP].++[`ST`]: https://hackage.haskell.org/package/base/docs/Control-Monad-ST.html+[`Prim`]: https://hackage.haskell.org/package/effectful-core/docs/Effectful-Prim.html+[`effectful`]: https://hackage.haskell.org/package/effectful-core+[`PrimMonad`]: https://hackage.haskell.org/package/primitive/docs/Control-Monad-Primitive.html#t:PrimMonad+[PVP]: https://pvp.haskell.org/++## Copyright++Each contributor waives their Copyright and Related Rights to+this work according to [CC0-1.0].++[CC0-1.0]: https://creativecommons.org/publicdomain/zero/1.0/++## Patent++Each contributor licenses you to do everything with this work that+would otherwise infringe any patent claims they can license or become+able to license.

@@ -0,0 +1,58 @@+cabal-version:      2.4+name:               effectful-st+version:            0.0.0.0+license:            CC0-1.0+license-file:       CC0-1.0.txt+author:             Russell Hernandez Ruiz+maintainer:         qrpnxz@hyperlife.xyz+stability:          stable+homepage:           https://sr.ht/~qrpnxz/effectful-st/+bug-reports:        https://todo.sr.ht/~qrpnxz/effectful-st+synopsis:           `ST`-style mutation for `effectful`.+description:+  An `ST`-style alternative to the `Prim` effect in `effectful` that+  allows safely running scoped state transformations without `IOE`.+  .+  The `Prim` effect allows the use of `PrimMonad` on `Eff` without+  allowing arbitrary `IO`. However, there is no safe way to run the+  effect without introducing the `IOE` effect because `Prim` has no+  way of delimiting the scope of the mutation to `runPrim`. In other+  words, `Prim` is effectively acting merely as a restricted form of+  `IOE` that only allows `PrimMonad`.+  .+  `STE` from this package on the other hand borrows the quantification+  trick from `Control.Monad.ST` to provide a safe way to run the effect+  purely.+category:           effectful+extra-source-files: README.md+extra-source-files: CHANGELOG.md++source-repository head+  type:     git+  location: https://git.sr.ht/~qrpnxz/effectful-st++source-repository this+  type:     git+  location: https://git.sr.ht/~qrpnxz/effectful-st+  tag:      0.0.0.0++library+  hs-source-dirs:   src+  exposed-modules:+      Effectful.ST+  build-depends:+      base >=4.13 && <4.18+    , effectful-core >1 && <2.2+    , primitive >=0.7 && <0.8+  default-language: Haskell2010+  ghc-options:+    -Wall+    -Wcompat+    -Widentities+    -Wincomplete-record-updates+    -Wincomplete-uni-patterns+    -Wpartial-fields+    -Wredundant-constraints+  ghc-options:+    -Wno-redundant-constraints+    -Wno-unticked-promoted-constructors

@@ -0,0 +1,102 @@+-- SPDX-License-Identifier: CC0-1.0+{-+Each contributor licenses you to do everything with this work that+would otherwise infringe any patent claims they can license or become+able to license.+-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE TypeOperators #-}+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE FlexibleContexts #-}+{-|+This modules provides the `STE` effect; a way to run+the effect purely, with `Prim`, or with `IOE`; and+functions for lifting abstract and concrete+state-transformer actions into `Eff`.+-}+module Effectful.ST+  ( -- * Effect+    STE+    -- * Handlers+  , runSTE+  , steAsPrim+  , steAsIOE+    -- * Operations+    -- ** Prim to STE+  , primToSTE+  , stToSTE+  , stToSTE'+  , ioToSTE+    -- ** Prim to IOE+  , primToIOE+  , stToIOE+  , stToIOE'+  ) where++import Control.Monad.ST ( RealWorld, ST )+import qualified Control.Monad.ST.Lazy as L++import Unsafe.Coerce ( unsafeCoerce )+import GHC.IO ( IO(IO) )++import Effectful+    ( type (:>), Effect, Dispatch(Static), DispatchOf, Eff, IOE )+import Effectful.Dispatch.Static+    ( evalStaticRep,+      unsafeEff_,+      SideEffects(NoSideEffects),+      StaticRep )+import Effectful.Prim ( Prim )++import Control.Monad.Primitive+    ( PrimBase(..), PrimMonad(PrimState) )++data STE s :: Effect+-- ^ An effect for delimited primitive state-transformer actions.+type instance DispatchOf (STE s) = Static NoSideEffects+data instance StaticRep (STE s) = STERep++-- | Run an 'Eff' computation with primitive state-transformer actions purely.+runSTE :: (forall s. Eff (STE s : es) a) -> Eff es a+runSTE eff = evalStaticRep STERep eff++-- | Interpret `STE` as `Prim`.+steAsPrim :: Prim :> es => Eff (STE (PrimState (Eff es)) : es) a -> Eff es a+steAsPrim = evalStaticRep STERep++-- | Interpret `STE` as `IOE`.+steAsIOE :: IOE :> es => Eff (STE RealWorld : es) a -> Eff es a+steAsIOE = evalStaticRep STERep++-- | Lift a primitive state-transformer action with `STE`.+primToSTE+  :: (PrimBase m, STE s :> es, PrimState m ~ s)+  => m a -> Eff es a+primToSTE = unsafeEff_ . IO . unsafeCoerce . internal++-- | Lift a strict `ST` action with `STE`.+stToSTE :: (STE s :> es) => ST s a -> Eff es a+stToSTE = primToSTE++-- | Lift a lazy `L.ST` action with `STE`.+stToSTE' :: (STE s :> es) => L.ST s a -> Eff es a+stToSTE' = primToSTE++-- | Lift an IO action with `STE`.+ioToSTE :: (STE RealWorld :> es) => IO a -> Eff es a+ioToSTE = primToSTE++-- | Lift a primitive state-transformer action with `IOE`.+primToIOE+  :: (PrimBase m, IOE :> es, PrimState m ~ RealWorld)+  => m a -> Eff es a+primToIOE = unsafeEff_ . IO . internal++-- | Lift a strict `ST` action with `IOE`.+stToIOE :: (IOE :> es) => ST RealWorld a -> Eff es a+stToIOE = primToIOE++-- | Lift a lazy `L.ST` action with `IOE`.+stToIOE' :: (IOE :> es) => L.ST RealWorld a -> Eff es a+stToIOE' = primToIOE