{-# LANGUAGE DerivingStrategies #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}

{- | Monad transformer providing 'MonadFail'. -}
module OM.Fail (
  FailT,
  runFailT,
) where


import Control.Exception.Safe (MonadThrow, MonadCatch)
import Control.Monad.IO.Class (MonadIO)
import Control.Monad.Logger (MonadLogger, MonadLoggerIO)
import Control.Monad.Trans.Class (MonadTrans)
import Control.Monad.Trans.Except (ExceptT, runExceptT, throwE)


{- | Monad transformer providing 'MonadFail'. -}
newtype FailT m a = FailT {
    forall (m :: * -> *) a. FailT m a -> ExceptT String m a
unFailT :: ExceptT String m a
  }
  deriving newtype (
    (forall a b. (a -> b) -> FailT m a -> FailT m b)
-> (forall a b. a -> FailT m b -> FailT m a) -> Functor (FailT m)
forall a b. a -> FailT m b -> FailT m a
forall a b. (a -> b) -> FailT m a -> FailT m b
forall (m :: * -> *) a b. Functor m => a -> FailT m b -> FailT m a
forall (m :: * -> *) a b.
Functor m =>
(a -> b) -> FailT m a -> FailT m b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall (m :: * -> *) a b.
Functor m =>
(a -> b) -> FailT m a -> FailT m b
fmap :: forall a b. (a -> b) -> FailT m a -> FailT m b
$c<$ :: forall (m :: * -> *) a b. Functor m => a -> FailT m b -> FailT m a
<$ :: forall a b. a -> FailT m b -> FailT m a
Functor, Functor (FailT m)
Functor (FailT m) =>
(forall a. a -> FailT m a)
-> (forall a b. FailT m (a -> b) -> FailT m a -> FailT m b)
-> (forall a b c.
    (a -> b -> c) -> FailT m a -> FailT m b -> FailT m c)
-> (forall a b. FailT m a -> FailT m b -> FailT m b)
-> (forall a b. FailT m a -> FailT m b -> FailT m a)
-> Applicative (FailT m)
forall a. a -> FailT m a
forall a b. FailT m a -> FailT m b -> FailT m a
forall a b. FailT m a -> FailT m b -> FailT m b
forall a b. FailT m (a -> b) -> FailT m a -> FailT m b
forall a b c. (a -> b -> c) -> FailT m a -> FailT m b -> FailT m c
forall (m :: * -> *). Monad m => Functor (FailT m)
forall (m :: * -> *) a. Monad m => a -> FailT m a
forall (m :: * -> *) a b.
Monad m =>
FailT m a -> FailT m b -> FailT m a
forall (m :: * -> *) a b.
Monad m =>
FailT m a -> FailT m b -> FailT m b
forall (m :: * -> *) a b.
Monad m =>
FailT m (a -> b) -> FailT m a -> FailT m b
forall (m :: * -> *) a b c.
Monad m =>
(a -> b -> c) -> FailT m a -> FailT m b -> FailT m c
forall (f :: * -> *).
Functor f =>
(forall a. a -> f a)
-> (forall a b. f (a -> b) -> f a -> f b)
-> (forall a b c. (a -> b -> c) -> f a -> f b -> f c)
-> (forall a b. f a -> f b -> f b)
-> (forall a b. f a -> f b -> f a)
-> Applicative f
$cpure :: forall (m :: * -> *) a. Monad m => a -> FailT m a
pure :: forall a. a -> FailT m a
$c<*> :: forall (m :: * -> *) a b.
Monad m =>
FailT m (a -> b) -> FailT m a -> FailT m b
<*> :: forall a b. FailT m (a -> b) -> FailT m a -> FailT m b
$cliftA2 :: forall (m :: * -> *) a b c.
Monad m =>
(a -> b -> c) -> FailT m a -> FailT m b -> FailT m c
liftA2 :: forall a b c. (a -> b -> c) -> FailT m a -> FailT m b -> FailT m c
$c*> :: forall (m :: * -> *) a b.
Monad m =>
FailT m a -> FailT m b -> FailT m b
*> :: forall a b. FailT m a -> FailT m b -> FailT m b
$c<* :: forall (m :: * -> *) a b.
Monad m =>
FailT m a -> FailT m b -> FailT m a
<* :: forall a b. FailT m a -> FailT m b -> FailT m a
Applicative, Applicative (FailT m)
Applicative (FailT m) =>
(forall a b. FailT m a -> (a -> FailT m b) -> FailT m b)
-> (forall a b. FailT m a -> FailT m b -> FailT m b)
-> (forall a. a -> FailT m a)
-> Monad (FailT m)
forall a. a -> FailT m a
forall a b. FailT m a -> FailT m b -> FailT m b
forall a b. FailT m a -> (a -> FailT m b) -> FailT m b
forall (m :: * -> *). Monad m => Applicative (FailT m)
forall (m :: * -> *) a. Monad m => a -> FailT m a
forall (m :: * -> *) a b.
Monad m =>
FailT m a -> FailT m b -> FailT m b
forall (m :: * -> *) a b.
Monad m =>
FailT m a -> (a -> FailT m b) -> FailT m b
forall (m :: * -> *).
Applicative m =>
(forall a b. m a -> (a -> m b) -> m b)
-> (forall a b. m a -> m b -> m b)
-> (forall a. a -> m a)
-> Monad m
$c>>= :: forall (m :: * -> *) a b.
Monad m =>
FailT m a -> (a -> FailT m b) -> FailT m b
>>= :: forall a b. FailT m a -> (a -> FailT m b) -> FailT m b
$c>> :: forall (m :: * -> *) a b.
Monad m =>
FailT m a -> FailT m b -> FailT m b
>> :: forall a b. FailT m a -> FailT m b -> FailT m b
$creturn :: forall (m :: * -> *) a. Monad m => a -> FailT m a
return :: forall a. a -> FailT m a
Monad, Monad (FailT m)
Monad (FailT m) =>
(forall a. IO a -> FailT m a) -> MonadIO (FailT m)
forall a. IO a -> FailT m a
forall (m :: * -> *).
Monad m =>
(forall a. IO a -> m a) -> MonadIO m
forall (m :: * -> *). MonadIO m => Monad (FailT m)
forall (m :: * -> *) a. MonadIO m => IO a -> FailT m a
$cliftIO :: forall (m :: * -> *) a. MonadIO m => IO a -> FailT m a
liftIO :: forall a. IO a -> FailT m a
MonadIO, Monad (FailT m)
Monad (FailT m) =>
(forall msg.
 ToLogStr msg =>
 Loc -> LogSource -> LogLevel -> msg -> FailT m ())
-> MonadLogger (FailT m)
forall msg.
ToLogStr msg =>
Loc -> LogSource -> LogLevel -> msg -> FailT m ()
forall (m :: * -> *).
Monad m =>
(forall msg.
 ToLogStr msg =>
 Loc -> LogSource -> LogLevel -> msg -> m ())
-> MonadLogger m
forall (m :: * -> *). MonadLogger m => Monad (FailT m)
forall (m :: * -> *) msg.
(MonadLogger m, ToLogStr msg) =>
Loc -> LogSource -> LogLevel -> msg -> FailT m ()
$cmonadLoggerLog :: forall (m :: * -> *) msg.
(MonadLogger m, ToLogStr msg) =>
Loc -> LogSource -> LogLevel -> msg -> FailT m ()
monadLoggerLog :: forall msg.
ToLogStr msg =>
Loc -> LogSource -> LogLevel -> msg -> FailT m ()
MonadLogger, MonadIO (FailT m)
MonadLogger (FailT m)
FailT m (Loc -> LogSource -> LogLevel -> LogStr -> IO ())
(MonadLogger (FailT m), MonadIO (FailT m)) =>
FailT m (Loc -> LogSource -> LogLevel -> LogStr -> IO ())
-> MonadLoggerIO (FailT m)
forall (m :: * -> *). MonadLoggerIO m => MonadIO (FailT m)
forall (m :: * -> *). MonadLoggerIO m => MonadLogger (FailT m)
forall (m :: * -> *).
MonadLoggerIO m =>
FailT m (Loc -> LogSource -> LogLevel -> LogStr -> IO ())
forall (m :: * -> *).
(MonadLogger m, MonadIO m) =>
m (Loc -> LogSource -> LogLevel -> LogStr -> IO ())
-> MonadLoggerIO m
$caskLoggerIO :: forall (m :: * -> *).
MonadLoggerIO m =>
FailT m (Loc -> LogSource -> LogLevel -> LogStr -> IO ())
askLoggerIO :: FailT m (Loc -> LogSource -> LogLevel -> LogStr -> IO ())
MonadLoggerIO,
    Monad (FailT m)
Monad (FailT m) =>
(forall e a. (HasCallStack, Exception e) => e -> FailT m a)
-> MonadThrow (FailT m)
forall e a. (HasCallStack, Exception e) => e -> FailT m a
forall (m :: * -> *).
Monad m =>
(forall e a. (HasCallStack, Exception e) => e -> m a)
-> MonadThrow m
forall (m :: * -> *). MonadThrow m => Monad (FailT m)
forall (m :: * -> *) e a.
(MonadThrow m, HasCallStack, Exception e) =>
e -> FailT m a
$cthrowM :: forall (m :: * -> *) e a.
(MonadThrow m, HasCallStack, Exception e) =>
e -> FailT m a
throwM :: forall e a. (HasCallStack, Exception e) => e -> FailT m a
MonadThrow, MonadThrow (FailT m)
MonadThrow (FailT m) =>
(forall e a.
 (HasCallStack, Exception e) =>
 FailT m a -> (e -> FailT m a) -> FailT m a)
-> MonadCatch (FailT m)
forall e a.
(HasCallStack, Exception e) =>
FailT m a -> (e -> FailT m a) -> FailT m a
forall (m :: * -> *).
MonadThrow m =>
(forall e a.
 (HasCallStack, Exception e) =>
 m a -> (e -> m a) -> m a)
-> MonadCatch m
forall (m :: * -> *). MonadCatch m => MonadThrow (FailT m)
forall (m :: * -> *) e a.
(MonadCatch m, HasCallStack, Exception e) =>
FailT m a -> (e -> FailT m a) -> FailT m a
$ccatch :: forall (m :: * -> *) e a.
(MonadCatch m, HasCallStack, Exception e) =>
FailT m a -> (e -> FailT m a) -> FailT m a
catch :: forall e a.
(HasCallStack, Exception e) =>
FailT m a -> (e -> FailT m a) -> FailT m a
MonadCatch, (forall (m :: * -> *). Monad m => Monad (FailT m)) =>
(forall (m :: * -> *) a. Monad m => m a -> FailT m a)
-> MonadTrans FailT
forall (m :: * -> *). Monad m => Monad (FailT m)
forall (m :: * -> *) a. Monad m => m a -> FailT m a
forall (t :: (* -> *) -> * -> *).
(forall (m :: * -> *). Monad m => Monad (t m)) =>
(forall (m :: * -> *) a. Monad m => m a -> t m a) -> MonadTrans t
$clift :: forall (m :: * -> *) a. Monad m => m a -> FailT m a
lift :: forall (m :: * -> *) a. Monad m => m a -> FailT m a
MonadTrans
  )
instance (Monad m) => MonadFail (FailT m) where
  fail :: forall a. String -> FailT m a
fail = ExceptT String m a -> FailT m a
forall (m :: * -> *) a. ExceptT String m a -> FailT m a
FailT (ExceptT String m a -> FailT m a)
-> (String -> ExceptT String m a) -> String -> FailT m a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> ExceptT String m a
forall (m :: * -> *) e a. Monad m => e -> ExceptT e m a
throwE


{- | Run a 'FailT'. -}
runFailT :: FailT m a -> m (Either String a)
runFailT :: forall (m :: * -> *) a. FailT m a -> m (Either String a)
runFailT = ExceptT String m a -> m (Either String a)
forall e (m :: * -> *) a. ExceptT e m a -> m (Either e a)
runExceptT (ExceptT String m a -> m (Either String a))
-> (FailT m a -> ExceptT String m a)
-> FailT m a
-> m (Either String a)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. FailT m a -> ExceptT String m a
forall (m :: * -> *) a. FailT m a -> ExceptT String m a
unFailT