{-# LANGUAGE KindSignatures #-}
{-# LANGUAGE PatternSynonyms #-}

{- | An effect providing failure with an error message.

This effect is invoked through the 'Fail.fail' method from 'Fail.MonadFail'.

Predefined carriers:

* "Control.Carrier.Fail.Either"

@since 0.1.0.0
-}

module Control.Effect.Fail
( -- * Fail effect
  Fail
, pattern Fail
, Fail.MonadFail(..)
  -- * Re-exports
, Algebra
, Has
, run
) where

import Control.Effect.Throw
import Control.Monad.Fail as Fail

-- | @since 0.1.0.0
type Fail = Throw String

-- | @since 1.0.0.0
pattern Fail :: String -> Fail m k
pattern $bFail :: forall (m :: * -> *) k. String -> Fail m k
$mFail :: forall {r} {m :: * -> *} {k}.
Fail m k -> (String -> r) -> ((# #) -> r) -> r
Fail s = Throw s

{-# COMPLETE Fail #-}