Copyright	(c) 2016 Stephen Diehl (c) 20016-2018 Serokell (c) 2018 Kowainik
License	MIT
Maintainer	Kowainik <xrom.xkov@gmail.com>
Safe Haskell	Safe
Language	Haskell2010

Relude.Monad.Either

Contents

Description

Utilites to work with Either data type.

Synopsis

Documentation

fromLeft :: a -> Either a b -> a #

Return the contents of a Left-value or a default value otherwise.

Expand

Basic usage:

>>> fromLeft 1 (Left 3)
3
>>> fromLeft 1 (Right "foo")
1

Since: base-4.10.0.0

fromRight :: b -> Either a b -> b #

Return the contents of a Right-value or a default value otherwise.

Expand

Basic usage:

>>> fromRight 1 (Right 3)
3
>>> fromRight 1 (Left "foo")
1

Since: base-4.10.0.0

Maps Maybe to Either wrapping default value into Right.

>>> maybeToLeft True (Just "aba")
Left "aba"
>>> maybeToLeft True Nothing
Right True

Maps Maybe to Either wrapping default value into Left.

>>> maybeToRight True (Just "aba")
Right "aba"
>>> maybeToRight True Nothing
Left True

Maps left part of Either to Maybe.

>>> leftToMaybe (Left True)
Just True
>>> leftToMaybe (Right "aba")
Nothing

Maps right part of Either to Maybe.

>>> rightToMaybe (Left True)
Nothing
>>> rightToMaybe (Right "aba")
Just "aba"

whenLeft :: Applicative f => a -> Either l r -> (l -> f a) -> f a Source #

Applies given action to Either content if Left is given and returns the result. In case of Right the default value will be returned.

whenLeft_ :: Applicative f => Either l r -> (l -> f ()) -> f () Source #

Applies given action to Either content if Left is given.

whenLeftM :: Monad m => a -> m (Either l r) -> (l -> m a) -> m a Source #

Monadic version of whenLeft.

whenLeftM_ :: Monad m => m (Either l r) -> (l -> m ()) -> m () Source #

Monadic version of whenLeft_.

whenRight :: Applicative f => a -> Either l r -> (r -> f a) -> f a Source #

Applies given action to Either content if Right is given and returns the result. In case of Left the default value will be returned.

whenRight_ :: Applicative f => Either l r -> (r -> f ()) -> f () Source #

Applies given action to Either content if Right is given.

whenRightM :: Monad m => a -> m (Either l r) -> (r -> m a) -> m a Source #

Monadic version of whenRight.

whenRightM_ :: Monad m => m (Either l r) -> (r -> m ()) -> m () Source #

Monadic version of whenRight_.

Orphan instances

IsString str => MonadFail (Either str) Source #
Instance details Methods fail :: String -> Either str a #