Effectful.Environment

Effect

data Environment :: Effect

An effect for querying and modifying the system environment.

Instances

type DispatchOf Environment

Defined in Effectful.Environment

type DispatchOf Environment = 'Static 'WithSideEffects

data StaticRep Environment

Defined in Effectful.Environment

data StaticRep Environment = Environment

Handlers

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

Run the Environment effect.

Querying the environment

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

Lifted getArgs.

getProgName :: Environment :> es => Eff es String

Lifted getProgName.

getExecutablePath :: Environment :> es => Eff es FilePath

Lifted getExecutablePath.

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

Lifted getEnv.

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

Lifted getEnvironment.

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

Lifted lookupEnv.

Modifying the environment

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

Lifted setEnv.

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

Lifted unsetEnv.

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

Lifted withArgs.

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

Lifted withProgName.