Moduleeffectful-2.7.1.0GHC2021

Effectful.Environment

Contents

Effect
Handlers
Querying the environment
Modifying the environment

Synopsis

data Environment
value runEnvironment
value getArgs
value getProgName
value getExecutablePath
value getEnv
value getEnvironment
value lookupEnv
value setEnv
value unsetEnv
value withArgs
value withProgName

Packageeffectful-2.7.1.0
Exports12
LanguageGHC2021
LicenceBSD-3-Clause
SourceEnvironment.hs

Effect

datadata Environment (a :: Type -> Type) b

Source#

An effect for querying and modifying the system environment.

Instances2DispatchOf, StaticRep

type DispatchOf Environment = 'Static 'WithSideEffectsDefined in effectful-2.7.1.0 · Effectful.Environment
data StaticRep Environment
- Environment
Defined in effectful-2.7.1.0 · Effectful.Environment

Handlers

valuerunEnvironment

:: (HasCallStack, IOE :> es)
=> Eff (Environment ': es) a
-> Eff es a

Source#

Run the Environment effect.

Querying the environment

valuegetArgs :: Environment :> es => Eff es [String]

Source#

Lifted getArgs.

valuegetProgName :: Environment :> es => Eff es String

Source#

Lifted getProgName.

valuegetExecutablePath :: Environment :> es => Eff es FilePath

Source#

Lifted getExecutablePath.

valuegetEnv :: Environment :> es => String -> Eff es String

Source#

Lifted getEnv.

valuegetEnvironment :: Environment :> es => Eff es [(String, String)]

Source#

Lifted getEnvironment.

valuelookupEnv :: Environment :> es => String -> Eff es (Maybe String)

Source#

Lifted lookupEnv.

Modifying the environment

valuesetEnv :: Environment :> es => String -> String -> Eff es ()

Source#

Lifted setEnv.

valueunsetEnv :: Environment :> es => String -> Eff es ()

Source#

Lifted unsetEnv.

valuewithArgs :: Environment :> es => [String] -> Eff es a -> Eff es a

Source#

Lifted withArgs.

valuewithProgName :: Environment :> es => String -> Eff es a -> Eff es a

Source#

Lifted withProgName.