Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Haskell.DoNotation

Description

This module provides new implementations for (>>=), (>>), pure and return so that they will work simultaneously with both regular and indexed monads.

Intended usage:

@@ {-# LANGUAGE RebindableSyntax #-}

import Language.Haskell.DoNotation import Prelude hiding (Monad (..), pure) @@

Synopsis

class BindSyntax (x :: Type -> Type) (y :: Type -> Type) (z :: Type -> Type) | x y -> z, x z -> y, y z -> x where
- (>>=) :: x a -> (a -> y b) -> z b
- (>>) :: x a -> y b -> z b
class PureSyntax (x :: Type -> Type) where
- pure :: a -> x a
- return :: a -> x a
class Applicative m => Monad (m :: Type -> Type)
class IxApplicative m => IxMonad (m :: k -> k -> Type -> Type)

Documentation

class BindSyntax (x :: Type -> Type) (y :: Type -> Type) (z :: Type -> Type) | x y -> z, x z -> y, y z -> x where Source #

Typeclass that provides (>>=) and (>>).

Minimal complete definition

(>>=)

Methods

(>>=) :: x a -> (a -> y b) -> z b Source #

(>>) :: x a -> y b -> z b Source #

Instances

Instances details

(Monad m, x ~ m) => BindSyntax m x m Source #
Instance details Defined in Language.Haskell.DoNotation Methods (>>=) :: m a -> (a -> x b) -> m b Source # (>>) :: m a -> x b -> m b Source #
(IxMonad m, x ~ m i j, y ~ m j k2, z ~ m i k2) => BindSyntax x y z Source #
Instance details Defined in Language.Haskell.DoNotation Methods (>>=) :: x a -> (a -> y b) -> z b Source # (>>) :: x a -> y b -> z b Source #

class PureSyntax (x :: Type -> Type) where Source #

Typeclass that provides pure and return.

Minimal complete definition

Nothing

Methods

pure :: a -> x a Source #

return :: a -> x a Source #

Instances

Instances details

Applicative m => PureSyntax m Source #
Instance details Defined in Language.Haskell.DoNotation Methods pure :: a -> m a Source # return :: a -> m a Source #
(IxMonad m, j ~ i) => PureSyntax (m i j) Source #
Instance details Defined in Language.Haskell.DoNotation Methods pure :: a -> m i j a Source # return :: a -> m i j a Source #

class Applicative m => Monad (m :: Type -> Type) #

The Monad class defines the basic operations over a monad, a concept from a branch of mathematics known as category theory. From the perspective of a Haskell programmer, however, it is best to think of a monad as an abstract datatype of actions. Haskell's do expressions provide a convenient syntax for writing monadic expressions.

Instances of Monad should satisfy the following:

Left identity: return a >>= k = k a
Right identity: m >>= return = m
Associativity: m >>= (\x -> k x >>= h) = (m >>= k) >>= h

Furthermore, the Monad and Applicative operations should relate as follows:

```
pure = return
```

m1 <*> m2 = m1 >>= (x1 -> m2 >>= (x2 -> return (x1 x2)))

The above laws imply:

```
fmap f xs  =  xs >>= return . f
```
```
(>>) = (*>)
```

and that pure and (<*>) satisfy the applicative functor laws.

The instances of Monad for lists, Maybe and IO defined in the Prelude satisfy these laws.

Minimal complete definition

(>>=)

Instances

Instances details

Monad P	Since: base-2.1
Instance details Defined in Text.ParserCombinators.ReadP Methods (>>=) :: P a -> (a -> P b) -> P b # (>>) :: P a -> P b -> P b # return :: a -> P a #
Monad ReadP	Since: base-2.1
Instance details Defined in Text.ParserCombinators.ReadP Methods (>>=) :: ReadP a -> (a -> ReadP b) -> ReadP b # (>>) :: ReadP a -> ReadP b -> ReadP b # return :: a -> ReadP a #
Monad IO	Since: base-2.1
Instance details Defined in GHC.Base Methods (>>=) :: IO a -> (a -> IO b) -> IO b # (>>) :: IO a -> IO b -> IO b # return :: a -> IO a #
Monad NonEmpty	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods (>>=) :: NonEmpty a -> (a -> NonEmpty b) -> NonEmpty b # (>>) :: NonEmpty a -> NonEmpty b -> NonEmpty b # return :: a -> NonEmpty a #
Monad Maybe	Since: base-2.1
Instance details Defined in GHC.Base Methods (>>=) :: Maybe a -> (a -> Maybe b) -> Maybe b # (>>) :: Maybe a -> Maybe b -> Maybe b # return :: a -> Maybe a #
Monad Solo	Since: base-4.15
Instance details Defined in GHC.Base Methods (>>=) :: Solo a -> (a -> Solo b) -> Solo b # (>>) :: Solo a -> Solo b -> Solo b # return :: a -> Solo a #
Monad []	Since: base-2.1
Instance details Defined in GHC.Base Methods (>>=) :: [a] -> (a -> [b]) -> [b] # (>>) :: [a] -> [b] -> [b] # return :: a -> [a] #
Monad (Either e)	Since: base-4.4.0.0
Instance details Defined in Data.Either Methods (>>=) :: Either e a -> (a -> Either e b) -> Either e b # (>>) :: Either e a -> Either e b -> Either e b # return :: a -> Either e a #
Monoid a => Monad ((,) a)	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods (>>=) :: (a, a0) -> (a0 -> (a, b)) -> (a, b) # (>>) :: (a, a0) -> (a, b) -> (a, b) # return :: a0 -> (a, a0) #
(Monoid a, Monoid b) => Monad ((,,) a b)	Since: base-4.14.0.0
Instance details Defined in GHC.Base Methods (>>=) :: (a, b, a0) -> (a0 -> (a, b, b0)) -> (a, b, b0) # (>>) :: (a, b, a0) -> (a, b, b0) -> (a, b, b0) # return :: a0 -> (a, b, a0) #
(Monoid a, Monoid b, Monoid c) => Monad ((,,,) a b c)	Since: base-4.14.0.0
Instance details Defined in GHC.Base Methods (>>=) :: (a, b, c, a0) -> (a0 -> (a, b, c, b0)) -> (a, b, c, b0) # (>>) :: (a, b, c, a0) -> (a, b, c, b0) -> (a, b, c, b0) # return :: a0 -> (a, b, c, a0) #
Monad ((->) r)	Since: base-2.1
Instance details Defined in GHC.Base Methods (>>=) :: (r -> a) -> (a -> r -> b) -> r -> b # (>>) :: (r -> a) -> (r -> b) -> r -> b # return :: a -> r -> a #
Monad m => Monad (Ix m i j) Source #
Instance details Defined in Control.Monad.Trans.Ix Methods (>>=) :: Ix m i j a -> (a -> Ix m i j b) -> Ix m i j b # (>>) :: Ix m i j a -> Ix m i j b -> Ix m i j b # return :: a -> Ix m i j a #

class IxApplicative m => IxMonad (m :: k -> k -> Type -> Type) #

Minimal complete definition

ibind

Instances

Instances details

Monad m => IxMonad (Ix m :: k -> k -> Type -> TYPE LiftedRep) Source #
Instance details Defined in Control.Monad.Trans.Ix Methods ibind :: forall a (j :: k0) (k1 :: k0) b (i :: k0). (a -> Ix m j k1 b) -> Ix m i j a -> Ix m i k1 b #