Exit.hs

{-# LANGUAGE Safe #-}

{- |
Module                  : Relude.Lifted.Exit
Copyright               : (c) 2016 Stephen Diehl
                          (c) 2016-2018 Serokell
                          (c) 2018-2023 Kowainik
SPDX-License-Identifier : MIT
Maintainer              : Kowainik <xrom.xkov@gmail.com>
Stability               : Stable
Portability             : Portable

Lifted versions of functions that work with exit processes.
-}

module Relude.Lifted.Exit
    ( exitWith
    , exitFailure
    , exitSuccess
    , die
    ) where

import Control.Monad.Trans (MonadIO, liftIO)
import Data.String (String)
import System.Exit (ExitCode)

import qualified System.Exit as XIO


-- $setup
-- >>> import Relude
-- >>> import System.Exit (ExitCode (..))


{- | Lifted version of 'System.Exit.exitWith'.

>>> exitWith (ExitFailure 3)
*** Exception: ExitFailure 3

>>> exitWith ExitSuccess
*** Exception: ExitSuccess
-}
exitWith :: MonadIO m => ExitCode -> m a
exitWith a = liftIO (XIO.exitWith a)

{- | Lifted version of 'System.Exit.exitFailure'.

>>> exitFailure
*** Exception: ExitFailure 1
-}
exitFailure :: MonadIO m => m a
exitFailure = liftIO XIO.exitFailure

{- | Lifted version of 'System.Exit.exitSuccess'.

>>> exitSuccess
*** Exception: ExitSuccess
-}
exitSuccess :: MonadIO m => m a
exitSuccess = liftIO XIO.exitSuccess

{- | Lifted version of 'System.Exit.die'.

>>> die "Goodbye!"
Goodbye!
*** Exception: ExitFailure 1
-}
die :: MonadIO m => String -> m a
die err = liftIO (XIO.die err)