Freckle.App.Env.Internal

Internal Env machinery exposed for testing

Documentation

data Error

Environment parsing errors

Constructors

UnsetError

A variable was not found, and no default was specified

InvalidError String

A variable was found, but it failed to parse

Instances

Eq Error

Defined in Freckle.App.Env.Internal

Methods

(==) :: Error -> Error -> Bool

(/=) :: Error -> Error -> Bool

Show Error

Defined in Freckle.App.Env.Internal

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

newtype Parser a

Parse an Environment

Errors are accumulated into tuples mapping name to error.

Constructors

Parser

Fields

• unParser :: [(String, String)] -> Either [(String, Error)] a

Instances

Functor Parser

Defined in Freckle.App.Env.Internal

Methods

fmap :: (a -> b) -> Parser a -> Parser b

(<$) :: a -> Parser b -> Parser a

Applicative Parser

Defined in Freckle.App.Env.Internal

Methods

pure :: a -> Parser a

(<*>) :: Parser (a -> b) -> Parser a -> Parser b

liftA2 :: (a -> b -> c) -> Parser a -> Parser b -> Parser c

(*>) :: Parser a -> Parser b -> Parser b

(<*) :: Parser a -> Parser b -> Parser a

Alternative Parser

Defined in Freckle.App.Env.Internal

Methods

empty :: Parser a

(<|>) :: Parser a -> Parser a -> Parser a

some :: Parser a -> Parser [a]

many :: Parser a -> Parser [a]

bindParser :: Parser a -> (a -> Parser b) -> Parser b

Monadic bind for Parser

This short-circuits all parsing and is not ideal for an applicative style parser, which ideally reports all errors instead of short-circuiting. As such a Monad instance is not exposed for Parser.

newtype Reader a

Read a single environment variable's value

This will only ever fail with InvalidError, since UnsetError is handled before invoking any Reader.

Constructors

Reader

Fields

• unReader :: String -> Either Error a

Instances

Functor Reader

Defined in Freckle.App.Env.Internal

Methods

fmap :: (a -> b) -> Reader a -> Reader b

(<$) :: a -> Reader b -> Reader a

newtype Mod a

Constructors

Mod (Var a -> Var a)

Instances

Semigroup (Mod a)

Defined in Freckle.App.Env.Internal

Methods

(<>) :: Mod a -> Mod a -> Mod a

sconcat :: NonEmpty (Mod a) -> Mod a

stimes :: Integral b => b -> Mod a -> Mod a

Monoid (Mod a)

Defined in Freckle.App.Env.Internal

Methods

mempty :: Mod a

mappend :: Mod a -> Mod a -> Mod a

mconcat :: [Mod a] -> Mod a

data Var a

Constructors

Var

Fields

• varName :: String
• varReader :: Reader a
• varDefault :: Maybe a

varParser :: Var a -> Parser a