Safe Haskell	None
Language	Haskell2010

MiniLight.Component.Loader

Synopsis

module MiniLight.Component.Internal.Types
data LoaderEnv = LoaderEnv {
- registry :: Registry Component
- appConfig :: IORef AppConfig
}
class HasLoaderEnv c where
- loaderEnv :: Lens' c LoaderEnv
- _appConfig :: Lens' c (IORef AppConfig)
- _registry :: Lens' c (Registry Component)
resolveConfig :: MonadIO m => FilePath -> m (Either String AppConfig)
loadAppConfig :: (HasLightEnv env, HasLoaderEnv env, MonadIO m, MonadCatch m) => FilePath -> Resolver -> LightT env m ()
patchAppConfig :: (HasLightEnv env, HasLoaderEnv env, MonadIO m, MonadCatch m) => FilePath -> Resolver -> LightT env m ()

Documentation

module MiniLight.Component.Internal.Types

data LoaderEnv Source #

The environment for config loader

Constructors

LoaderEnv
Fields registry :: Registry Component appConfig :: IORef AppConfig

Instances

HasLoaderEnv LoaderEnv Source #
Instance details Defined in MiniLight.Component.Loader Methods loaderEnv :: Lens' LoaderEnv LoaderEnv Source # _appConfig :: Lens' LoaderEnv (IORef AppConfig) Source # _registry :: Lens' LoaderEnv (Registry Component) Source #

class HasLoaderEnv c where Source #

Minimal complete definition

loaderEnv

Methods

loaderEnv :: Lens' c LoaderEnv Source #

_appConfig :: Lens' c (IORef AppConfig) Source #

_registry :: Lens' c (Registry Component) Source #

Instances

HasLoaderEnv LoaderEnv Source #
Instance details Defined in MiniLight.Component.Loader Methods loaderEnv :: Lens' LoaderEnv LoaderEnv Source # _appConfig :: Lens' LoaderEnv (IORef AppConfig) Source # _registry :: Lens' LoaderEnv (Registry Component) Source #
HasLoaderEnv LoopState Source #
Instance details Defined in MiniLight Methods loaderEnv :: Lens' LoopState LoaderEnv Source # _appConfig :: Lens' LoopState (IORef AppConfig) Source # _registry :: Lens' LoopState (Registry Component) Source #
HasLoaderEnv env' => HasLoaderEnv (env, env') Source #
Instance details Defined in MiniLight Methods loaderEnv :: Lens' (env, env') LoaderEnv Source # _appConfig :: Lens' (env, env') (IORef AppConfig) Source # _registry :: Lens' (env, env') (Registry Component) Source #

resolveConfig :: MonadIO m => FilePath -> m (Either String AppConfig) Source #

Load an config file and return the resolved AppConfig.

loadAppConfig Source #

Arguments

:: (HasLightEnv env, HasLoaderEnv env, MonadIO m, MonadCatch m)
=> FilePath	Filepath to the yaml file.
-> Resolver	Specify any resolver.
-> LightT env m ()

Load an config file and set in the environment. Calling this function at once, this overrides all values in the environment. This will generate an error log and skip the component if the configuration is invalid. This function also assign unique IDs for each component, using assignUID.

patchAppConfig Source #

Arguments

:: (HasLightEnv env, HasLoaderEnv env, MonadIO m, MonadCatch m)
=> FilePath	Filepath to the yaml file.
-> Resolver	Specify any resolver.
-> LightT env m ()

Load the config file again and place the newly loaded components. This is used for HCR (hot component replacement). Call loadAppConfig first.