Data.Yaml.Config

Documentation

data Config

(Sub)Config type

Instances

Eq Config

Show Config

NFData Config

type Key = Text

Subconfig or field name

load :: FilePath -> IO Config

Find file in filesystem and try to load it as YAML config May fail with KeyError

keys :: Config -> [Key]

Show all (sub)config first level filed's name

lookupSubconfig

Arguments

:: Config

(Sub)Config for find

-> Key

Field name

-> Maybe Config

Maybe Subconfig

Subconfig wrapped into Maybe

subconfig

Arguments

:: Config

(Sub)Config for find

-> Key

Subconfig name

-> IO Config

Subconfig

Find subconfig May fail with KeyError

lookup

Arguments

:: FromJSON a

=> Config

(Sub)Config for find

-> Key

Field name

-> Maybe a

Field value

Field value wrapped into Maybe (sub)config

lookupDefault

Arguments

:: FromJSON a

=> Config

(Sub)Config for find

-> Key

Field name

-> a

Default value

-> a

Return value

Find value in (sub)config and return it or default value

require :: FromJSON a => Config -> Key -> IO a

Same as lookup buf fail with KeyError if there is no field with target name