Safe Haskell | Safe-Inferred |
---|---|
Language | GHC2021 |
Synopsis
- type Name = String
- data Error
- string :: IsString a => Name -> Scan a
- yaml :: (Show a, FromJSON a) => Name -> Scan a
- parse :: Show a => Name -> (String -> Either String a) -> Scan a
- secret :: Scan a -> Scan a
- stringDefault :: IsString a => Name -> String -> Scan a
- yamlDefault :: (Show a, FromJSON a) => Name -> a -> Scan a
- parseDefault :: Show a => Name -> a -> (String -> Either String a) -> Scan a
- data Settings = Settings {
- parseLogger :: Name -> String -> IO ()
- errorLogger :: Error -> IO ()
- unusedLogger :: Name -> Maybe (IO ())
- pedantic :: Bool
- def :: Default a => a
- scan :: Scan a -> IO a
- scanWith :: Settings -> Scan a -> IO a
- enumerate :: Scan a -> [Name]
- assumePrefix :: String -> Name -> Maybe (IO ())
- obsolete :: [Name] -> Name -> Maybe (IO ())
- data Scan a where
Documentation
Parsers
yaml :: (Show a, FromJSON a) => Name -> Scan a Source #
Parse the environment variable as a YAML value.
Providing a default value
yamlDefault :: (Show a, FromJSON a) => Name -> a -> Scan a Source #
Parse the environment variable as a YAML value.
Runner
Settings | |
|
Logger
assumePrefix :: String -> Name -> Maybe (IO ()) Source #
Custom logging function for unusedLogger
.
prints a warning for each unused environment variable prefixed by assumePrefix
pp
.
obsolete :: [Name] -> Name -> Maybe (IO ()) Source #
prints a warning if any of the obsolete
namesnames
is set but not used.