Iris.Env

Environment of a CLI app.

Since: 0.0.0.0

CLI application environment

Constructing

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

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

MonadReader (CliEnv cmd appEnv) (CliApp cmd appEnv)

Since: 0.0.0.0

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

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

Since: 0.0.0.0

Querying

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

Get a field from the global environment CliEnv.

Since: 0.0.0.0

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

Get a field from custom application-specific environment appEnv.

Since: 0.0.0.0