Copyright | (c) Moritz Clasmeier 2018 |
---|---|
License | BSD3 |
Maintainer | mtesseract@silverratio.net |
Stability | experimental |
Portability | POSIX |
Safe Haskell | None |
Language | Haskell2010 |
This is an experimental API.
Nakadi-client provides a MonadNakadi
instance for the IO
monad
accessing a global mutable configuration.
This module exports the user-visible API for managing this global configuration.
Synopsis
- initializeGlobalConfigurationFromEnv :: (MonadIO m, MonadThrow m) => m ()
- setGlobalConfiguration :: MonadIO m => ConfigIO -> m ()
- modifyGlobalConfiguration :: MonadIO m => (ConfigIO -> ConfigIO) -> m ()
Documentation
initializeGlobalConfigurationFromEnv :: (MonadIO m, MonadThrow m) => m () Source #
Initialize the global configuration used by the MonadNakadi
instance
for the IO
monad via newConfigFromEnv
.
Experimental API.
setGlobalConfiguration :: MonadIO m => ConfigIO -> m () Source #
Sets the global configuration used by the MonadNakadi
instance
for the IO
monad to the provided configuration.
Experimental API.
modifyGlobalConfiguration :: MonadIO m => (ConfigIO -> ConfigIO) -> m () Source #
Modifies the global configuration used by the MonadNakadi
instance
for the IO
monad using the provided function. If no global configuration has
been set so far (using initializeGlobalConfigurationFromEnv
or
setGlobalConfiguration
), this will throw a ConfigurationMissing
exception.
Experimental API.