Copyright	(c) 2022 Dmitrii Kovanikov
License	MPL-2.0
Maintainer	Dmitrii Kovanikov <kovanikov@gmail.com>
Stability	Experimental
Portability	Portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Iris.Env

Contents

Settings for the CLI app
CLI application environment
- Constructing
- Querying

Description

Environment of a CLI app.

Since: 0.0.0.0

Synopsis

data CliEnvSettings (cmd :: Type) (appEnv :: Type) = CliEnvSettings {
- cliEnvSettingsCmdParser :: Parser cmd
- cliEnvSettingsAppEnv :: appEnv
- cliEnvSettingsHeaderDesc :: String
- cliEnvSettingsProgDesc :: String
- cliEnvSettingsVersionSettings :: Maybe VersionSettings
- cliEnvSettingsRequiredTools :: [Tool cmd]
}
defaultCliEnvSettings :: CliEnvSettings () ()
data CliEnv (cmd :: Type) (appEnv :: Type) = CliEnv {
- cliEnvCmd :: cmd
- cliEnvStdoutColourMode :: ColourMode
- cliEnvStderrColourMode :: ColourMode
- cliEnvAppEnv :: appEnv
- cliEnvInteractiveMode :: InteractiveMode
}
newtype CliEnvException = CliEnvException {
- unCliEnvException :: CliEnvError
}
newtype CliEnvError = CliEnvToolError ToolCheckResult
mkCliEnv :: forall cmd appEnv. CliEnvSettings cmd appEnv -> IO (CliEnv cmd appEnv)
asksCliEnv :: MonadReader (CliEnv cmd appEnv) m => (CliEnv cmd appEnv -> field) -> m field
asksAppEnv :: MonadReader (CliEnv cmd appEnv) m => (appEnv -> field) -> m field

Settings for the CLI app

data CliEnvSettings (cmd :: Type) (appEnv :: Type) Source #

Since: 0.0.0.0

Constructors

CliEnvSettings
Fields cliEnvSettingsCmdParser :: Parser cmd Since: 0.0.0.0 cliEnvSettingsAppEnv :: appEnv Since: 0.0.0.0 cliEnvSettingsHeaderDesc :: String Since: 0.0.0.0 cliEnvSettingsProgDesc :: String Since: 0.0.0.0 cliEnvSettingsVersionSettings :: Maybe VersionSettings Since: 0.0.0.0 cliEnvSettingsRequiredTools :: [Tool cmd] Since: 0.0.0.0

defaultCliEnvSettings :: CliEnvSettings () () Source #

Since: 0.0.0.0

CLI application environment

Constructing

data CliEnv (cmd :: Type) (appEnv :: Type) Source #

CLI application environment. It contains default settings for every CLI app and parameter

Has the following type parameters:

cmd — application commands
appEnv — application-specific environment; use () if you don't have custom app environment

Since: 0.0.0.0

Constructors

CliEnv
Fields cliEnvCmd :: cmd Since: 0.0.0.0 cliEnvStdoutColourMode :: ColourMode Since: 0.0.0.0 cliEnvStderrColourMode :: ColourMode Since: 0.0.0.0 cliEnvAppEnv :: appEnv Since: 0.0.0.0 cliEnvInteractiveMode :: InteractiveMode Since: 0.0.0.0

Instances

Instances details

MonadReader (CliEnv cmd appEnv) (CliApp cmd appEnv) Source #	Since: 0.0.0.0
Instance details Defined in Iris.App Methods ask :: CliApp cmd appEnv (CliEnv cmd appEnv) # local :: (CliEnv cmd appEnv -> CliEnv cmd appEnv) -> CliApp cmd appEnv a -> CliApp cmd appEnv a # reader :: (CliEnv cmd appEnv -> a) -> CliApp cmd appEnv a #

newtype CliEnvException Source #

Since: 0.0.0.0

Constructors

CliEnvException
Fields unCliEnvException :: CliEnvError

Instances

Instances details

Exception CliEnvException Source #	Since: 0.0.0.0
Instance details Defined in Iris.Env Methods toException :: CliEnvException -> SomeException # fromException :: SomeException -> Maybe CliEnvException # displayException :: CliEnvException -> String #
Show CliEnvException Source #	Since: 0.0.0.0
Instance details Defined in Iris.Env Methods showsPrec :: Int -> CliEnvException -> ShowS # show :: CliEnvException -> String # showList :: [CliEnvException] -> ShowS #
Eq CliEnvException Source #	Since: 0.0.0.0
Instance details Defined in Iris.Env Methods (==) :: CliEnvException -> CliEnvException -> Bool # (/=) :: CliEnvException -> CliEnvException -> Bool #

newtype CliEnvError Source #

Since: 0.0.0.0

Constructors

CliEnvToolError ToolCheckResult

Since: 0.0.0.0

Instances

Instances details

Show CliEnvError Source #	Since: 0.0.0.0
Instance details Defined in Iris.Env Methods showsPrec :: Int -> CliEnvError -> ShowS # show :: CliEnvError -> String # showList :: [CliEnvError] -> ShowS #
Eq CliEnvError Source #	Since: 0.0.0.0
Instance details Defined in Iris.Env Methods (==) :: CliEnvError -> CliEnvError -> Bool # (/=) :: CliEnvError -> CliEnvError -> Bool #

mkCliEnv :: forall cmd appEnv. CliEnvSettings cmd appEnv -> IO (CliEnv cmd appEnv) Source #

Throws: CliEnvException

Since: 0.0.0.0

Querying

asksCliEnv :: MonadReader (CliEnv cmd appEnv) m => (CliEnv cmd appEnv -> field) -> m field Source #

Get a field from the global environment CliEnv.

Since: 0.0.0.0

asksAppEnv :: MonadReader (CliEnv cmd appEnv) m => (appEnv -> field) -> m field Source #

Get a field from custom application-specific environment appEnv.

Since: 0.0.0.0