23d96a4 · effectful · git.iko.soy

src/Effectful/Class/Reader.hs+1−1

compare with master

unifiedsplit

@@ -12,7 +12,7 @@ import Effectful.Internal.Monad

12import qualified Effectful.Reader as R

13

14-- | Compatiblity layer for a transition period from MTL-style effect handling

15−-- to 'Effective.Eff'.

15+-- to 'Effectful.Eff'.

16class Monad m => MonadReader r m where

17 {-# MINIMAL (ask | reader), local #-}

18 ask :: m r

src/Effectful/Class/State.hs+1−1

@@ -8,7 +8,7 @@ import Effectful.Internal.Monad

8import qualified Effectful.State.Dynamic as S

9

10-- | Compatiblity layer for a transition period from MTL-style effect handling

11−-- to 'Effective.Eff'.

11+-- to 'Effectful.Eff'.

12class Monad m => MonadState s m where

13 {-# MINIMAL state | get, put #-}

14

src/Effectful/Class/Writer.hs+1−1

@@ -9,7 +9,7 @@ import Effectful.Internal.Monad

9import qualified Effectful.Writer as W

10

11-- | Compatiblity layer for a transition period from MTL-style effect handling

12−-- to 'Effective.Eff'.

12+-- to 'Effectful.Eff'.

13class Monad m => MonadWriter w m where

14 {-# MINIMAL (writer | tell), listen #-}

15

src/Effectful/Internal/Env.hs+1−1

@@ -1,5 +1,5 @@

1{-# OPTIONS_HADDOCK not-home #-}

2−-- | The enviroment for 'Effective.Internal.Monad.Eff'.

2+-- | The enviroment for 'Effectful.Internal.Monad.Eff'.

3--

4-- This module is intended for internal use only, and may change without warning

5-- in subsequent releases.

src/Effectful/Internal/Has.hs+2−2

@@ -1,7 +1,7 @@

1{-# LANGUAGE AllowAmbiguousTypes #-}

2{-# LANGUAGE UndecidableInstances #-}

3{-# OPTIONS_HADDOCK not-home #-}

4−-- | Type-safe indexing for 'Effective.Internal.Monad.Env'.

4+-- | Type-safe indexing for 'Effectful.Internal.Monad.Env'.

5--

6-- This module is intended for internal use only, and may change without warning

7-- in subsequent releases.

@@ -30,6 +30,6 @@ instance {-# OVERLAPPING #-} e :> (e : es) where

30instance e :> es => e :> (x : es) where

31 ixOf = 1 + ixOf @e @es

32

33−-- | Get position of @e@ in the 'Effective.Internal.Env.Env'.

33+-- | Get position of @e@ in the 'Effectful.Internal.Env.Env'.

34ixEnv :: forall e es. e :> es => Int -> Int

35ixEnv n = n - ixOf @e @es - 1

src/Effectful/State.hs+2−2

@@ -6,8 +6,8 @@

6--

7-- - not suitable for sharing between multiple threads.

8--

9−-- If you plan to do the latter, have a look at "Effective.State.MVar" or

9+-- If you plan to do the latter, have a look at "Effectful.State.MVar" or

10−-- "Effective.State.Dynamic".

10+-- "Effectful.State.Dynamic".

11--

12module Effectful.State

13 ( State

src/Effectful/State/Dynamic.hs+1−1

@@ -1,7 +1,7 @@

1-- | The 'State' as an effect with dynamic dispatch.

2--

3-- It's not clear in which situation it's beneficial to use this instead of

4−-- "Effective.State" or "Effective.State.MVar" as you either:

4+-- "Effectful.State" or "Effectful.State.MVar" as you either:

5--

6-- - Share state between threads and need the synchonized version.

7--

src/Effectful/State/MVar.hs+1−1

@@ -2,7 +2,7 @@

2--

3-- Represented as an MVar underneath, therefore:

4--

5−-- - slower than "Effective.State"

5+-- - slower than "Effectful.State"

6--

7-- - suitable for sharing between multiple threads.

8--