Options.Harg.Sources.Env

Documentation

data EnvSource (f :: Type -> Type)

Source that enables a parser to read options from environment variables.

Constructors

EnvSource

Instances

GetSource EnvSource f

Defined in Options.Harg.Sources.Env

Associated Types

type SourceVal EnvSource :: Type

Methods

getSource :: HargCtx -> EnvSource f -> IO (SourceVal EnvSource)

Generic (EnvSource f)

Defined in Options.Harg.Sources.Env

Associated Types

type Rep (EnvSource f) :: Type -> Type

Methods

from :: EnvSource f -> Rep (EnvSource f) x

to :: Rep (EnvSource f) x -> EnvSource f

ProductB EnvSource

Defined in Options.Harg.Sources.Env

Methods

bprod :: EnvSource f -> EnvSource g -> EnvSource (Product f g)

buniq :: (forall (a :: k). f a) -> EnvSource f

TraversableB EnvSource

Defined in Options.Harg.Sources.Env

Methods

btraverse :: Applicative t => (forall (a :: k). f a -> t (g a)) -> EnvSource f -> t (EnvSource g)

FunctorB EnvSource

Defined in Options.Harg.Sources.Env

Methods

bmap :: (forall (a :: k). f a -> g a) -> EnvSource f -> EnvSource g

type SourceVal EnvSource

Defined in Options.Harg.Sources.Env

type SourceVal EnvSource = EnvSourceVal

type Rep (EnvSource f)

Defined in Options.Harg.Sources.Env

type Rep (EnvSource f) = D1 (MetaData "EnvSource" "Options.Harg.Sources.Env" "harg-0.3.0.0-inplace" False) (C1 (MetaCons "EnvSource" PrefixI False) (U1 :: Type -> Type))

newtype EnvSourceVal

Value of EnvSource, which is an association list between environment variable names and values (strings).

Constructors

EnvSourceVal Environment

Instances

FunctorB a => RunSource EnvSourceVal a

Defined in Options.Harg.Sources.Env

Methods

runSource :: Applicative f => EnvSourceVal -> a (Compose Opt f) -> [a (Compose SourceRunResult f)]

lookupEnv :: Environment -> String -> Maybe String

Try to get a value from the environment variable association list.

runEnvVarSource :: forall a f. (FunctorB a, Applicative f) => Environment -> a (Compose Opt f) -> a (Compose SourceRunResult f)