Env.Internal.Parser · envparse-0.6.0

newtypenewtype Parser e a

#

An environment parser

Constructors

Parser
- unParser :: Alt (VarF e) a

Instances3Functor, Applicative, Alternative

Functor (Parser e)Defined in envparse-0.6.0 · Env.Internal.Parser
Applicative (Parser e)Defined in envparse-0.6.0 · Env.Internal.Parser
Alternative (Parser e)Defined in envparse-0.6.0 · Env.Internal.Parser

datadata VarF e a

#

Constructors

VarF
- varfName :: String
- varfReader :: Reader e a
- varfHelp :: Maybe String
- varfDef :: Maybe a
- varfHelpDef :: Maybe String
- varfSensitive :: Bool

Instances1Functor

Functor (VarF e)Defined in envparse-0.6.0 · Env.Internal.Parser

valueparsePure

:: AsUnset e
=> Parser e a
-> [(String, String)]
-> Either [(String, e)] a

#

Try to parse a pure environment

valuetraverseSensitiveVar

:: Applicative m
=> Parser e a
-> String -> m b
-> m ()

#

newtypenewtype Mod (t :: Type -> Type) a

#

This represents a modification of the properties of a particular Parser. Combine them using the Monoid instance.

Constructors

Mod (t a -> t a)

Instances2Semigroup, Monoid

Semigroup (Mod t a)Defined in envparse-0.6.0 · Env.Internal.Parser
Monoid (Mod t a)Defined in envparse-0.6.0 · Env.Internal.Parser

valueprefixed :: String -> Parser e a -> Parser e a

#

The string to prepend to the name of every declared environment variable

valuevar :: AsUnset e => Reader e a -> String -> Mod Var a -> Parser e a

#

Parse a particular variable from the environment

>>> var str "EDITOR" (def "vim" <> helpDef show)

datadata Var a

#

Environment variable metadata

Constructors

Var
- varHelp :: Maybe String
- varHelpDef :: Maybe (a -> String)
- varDef :: Maybe a
- varSensitive :: Bool

Instances1HasHelp

HasHelp VarDefined in envparse-0.6.0 · Env.Internal.Parser

valuedefaultVar :: Var a

#

typetype Reader e a = String -> Either e a

#

An environment variable's value parser. Use (<=<) and (>=>) to combine these

valueeitherReader :: AsUnread e => (String -> Either String a) -> Reader e a

#

Create a Reader from a simple parser function

valuestr :: IsString s => Reader e s

#

The trivial reader

valuechar :: AsUnread e => Reader e Char

#

The single character string reader

valuenonempty :: (AsEmpty e, IsString s) => Reader e s

#

The reader that accepts only non-empty strings

valuesplitOn :: Char -> Reader e [String]

#

The reader that splits a string into a list of strings consuming the separator.

valueauto :: (AsUnread e, Read a) => Reader e a

#

The reader that uses the Read instance of the type

valuedef :: a -> Mod Var a

#

The default value of the variable

Note: specifying it means the parser won't ever fail.

valuehelpDef :: (a -> String) -> Mod Var a

#

Show the default value of the variable in help.

valueshowDef :: Show a => Mod Var a

#

Use the Show instance to show the default value of the variable in help.

valueflag

:: a
default value
-> a
active value
-> String
-> Mod Flag a
-> Parser e a

#

A flag that takes the active value if the environment variable is set and non-empty and the default value otherwise

Note: this parser never fails.

valueswitch :: String -> Mod Flag Bool -> Parser e Bool

#

A simple boolean flag

Note: this parser never fails.

datadata Flag a

#

Flag metadata

Instances1HasHelp

HasHelp FlagDefined in envparse-0.6.0 · Env.Internal.Parser

classclass HasHelp (t :: Type -> Type) where

#

A class of things that can have a help message attached to them

Instances2HasHelp

HasHelp FlagDefined in envparse-0.6.0 · Env.Internal.Parser
HasHelp VarDefined in envparse-0.6.0 · Env.Internal.Parser

valuehelp :: HasHelp t => String -> Mod t a

#

Attach help text to the variable

valuesensitive :: Parser e a -> Parser e a

#

Mark the enclosed variables as sensitive to remove them from the environment once they've been parsed successfully.