Moduleyesod-1.6.2.1Haskell2010

Yesod.Default.Config

3 types
6 values

Packageyesod-1.6.2.1
Exports9
LanguageHaskell2010
LicenceMIT
SourceConfig.hs

datadata DefaultEnv

A yesod-provided AppEnv, allows for Development, Testing, and Production environments

Development Testing Staging Production

Instances4Bounded, Enum, Read, Show

Bounded DefaultEnvDefined in yesod-1.6.2.1 · Yesod.Default.Config
Enum DefaultEnvDefined in yesod-1.6.2.1 · Yesod.Default.Config
Read DefaultEnvDefined in yesod-1.6.2.1 · Yesod.Default.Config
Show DefaultEnvDefined in yesod-1.6.2.1 · Yesod.Default.Config

valuefromArgs

:: (Read env, Show env, Enum env, Bounded env)
=> env -> Object -> Parser extra
-> IO (AppConfig env extra)

Load the app config from command line parameters

valuefromArgsSettings

:: (Read env, Show env, Enum env, Bounded env)
=> env -> IO (ConfigSettings env extra)
-> IO (AppConfig env extra)

Load the app config from command line parameters, using the given @ConfigSettings.

Since 1.2.2

valueloadDevelopmentConfig :: IO (AppConfig DefaultEnv ())

Load your development config (when using DefaultEnv)

datadata AppConfig environment extra

Dynamic per-environment configuration which can be loaded at run-time negating the need to recompile between environments.

Constructors

AppConfig
- appEnv :: environment
- appPort :: Int
- appRoot :: Text
- appHost :: HostPreference
- appExtra :: extra

Instances1Show

(Show environment, Show extra) => Show (AppConfig environment extra)Defined in yesod-1.6.2.1 · Yesod.Default.Config

datadata ConfigSettings environment extra

Constructors

ConfigSettings
- csEnv :: environment
  An arbitrary value, used below, to indicate the current running environment. Usually, you will use DefaultEnv for this type.
- csParseExtra :: environment -> Object -> Parser extra
  Load any extra data, to be used by the application.
- csFile :: environment -> IO FilePath
  Return the path to the YAML config file.
- csGetObject :: environment -> Value -> IO Value
  Get the sub-object (if relevant) from the given YAML source which contains the specific settings for the current environment.

valueconfigSettings :: Show env => env -> ConfigSettings env ()

Default config settings.

valueloadConfig

:: ConfigSettings environment extra
-> IO (AppConfig environment extra)

Load an AppConfig.

Some examples:

-- typical local development
Development:
  host: localhost
  port: 3000

  -- approot: will default to ""

-- typical outward-facing production box
Production:
  host: www.example.com

  -- port: will default 80
  -- host: will default to "*"
  -- approot: will default "http://www.example.com"

-- maybe you're reverse proxying connections to the running app
-- on some other port
Production:
  port: 8080
  approot: "http://example.com"
  host: "localhost"

valuewithYamlEnvironment

:: Show e
=> FilePath
the yaml file
-> e
the environment you want to load
-> (Value -> Parser a)
what to do with the mapping
-> IO a

Loads the configuration block in the passed file named by the passed environment, yields to the passed function as a mapping.

Errors in the case of a bad load or if your function returns Nothing.