Yi.Config.Simple.Types

exports from Yi.Config.Simple which are useful to "core yi" rather than just config files.

Documentation

newtype ConfigM a

The configuration monad. Run it with configMain.

Constructors

ConfigM

Fields

runConfigM :: StateT Config IO a

Instances

Monad ConfigM

Functor ConfigM

Applicative ConfigM

MonadIO ConfigM

MonadState Config ConfigM

type Field a = Accessor Config a

Fields that can be modified with (%=), get and modify.

customVariable :: YiConfigVariable a => Field a

Accessor for any YiConfigVariable, to be used by modules defining YiConfigVariables. Such modules should provide a custom-named field. For instance, take the following hypothetical YiConfigVariable:

newtype UserName = UserName { unUserName :: String }
  deriving(Typeable, Binary, Initializable)
instance YiConfigVariable UserName

$(nameDeriveAccessors ''UserName (n -> Just (n ++ "A")))

userName :: Field String
userName = unUserNameA . customVariable

Here, the hypothetical library would provide the field userName to be used in preference to customVariable.