| Copyright | (c) 2011 MailRank Inc. |
|---|---|
| License | BSD3 |
| Maintainer | Bryan O'Sullivan <bos@serpentine.com> |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | Safe |
| Language | Haskell98 |
Data.Configurator.Types
Description
Types for working with configuration files.
Synopsis
- data AutoConfig = AutoConfig {}
- data Config
- type Name = Text
- data Value
- class Configured a
- convert :: Configured a => Value -> Maybe a
- data Worth a
- data ConfigError = ParseError FilePath String
- data KeyError = KeyError Name
- data Pattern
- type ChangeHandler = Name -> Maybe Value -> IO ()
Documentation
data AutoConfig Source #
Directions for automatically reloading Config data.
Constructors
| AutoConfig | |
Fields
| |
Instances
| Show AutoConfig Source # | |
Defined in Data.Configurator.Types.Internal Methods showsPrec :: Int -> AutoConfig -> ShowS show :: AutoConfig -> String showList :: [AutoConfig] -> ShowS | |
A value in a Config.
Constructors
| Bool Bool | A Boolean. Represented in a configuration file as |
| String Text | A Unicode string. Represented in a configuration file as text surrounded by double quotes. Escape sequences:
|
| Number Rational | Integer. |
| List [Value] | Heterogeneous list. Represented in a configuration
file as an opening square bracket " |
Instances
| Eq Value Source # | |
| Data Value Source # | |
Defined in Data.Configurator.Types.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Value -> c Value gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Value dataTypeOf :: Value -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Value) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Value) gmapT :: (forall b. Data b => b -> b) -> Value -> Value gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r gmapQ :: (forall d. Data d => d -> u) -> Value -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> Value -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> Value -> m Value gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value | |
| Show Value Source # | |
| Configured Value Source # | |
Defined in Data.Configurator.Instances | |
class Configured a Source #
This class represents types that can be automatically and safely
converted from a Value to a destination type. If conversion
fails because the types are not compatible, Nothing is returned.
For an example of compatibility, a Value of Bool True cannot
be converted to an Int.
Minimal complete definition
Instances
convert :: Configured a => Value -> Maybe a Source #
Instances
Exceptions
data ConfigError Source #
An error occurred while processing a configuration file.
Constructors
| ParseError FilePath String |
Instances
| Show ConfigError Source # | |
Defined in Data.Configurator.Types.Internal Methods showsPrec :: Int -> ConfigError -> ShowS show :: ConfigError -> String showList :: [ConfigError] -> ShowS | |
| Exception ConfigError Source # | |
Defined in Data.Configurator.Types.Internal Methods toException :: ConfigError -> SomeException fromException :: SomeException -> Maybe ConfigError displayException :: ConfigError -> String | |
An error occurred while lookup up the given Name.
Instances
| Show KeyError Source # | |
| Exception KeyError Source # | |
Defined in Data.Configurator.Types.Internal Methods toException :: KeyError -> SomeException fromException :: SomeException -> Maybe KeyError displayException :: KeyError -> String | |
Notification of configuration changes
A pattern specifying the name of a property that has changed.
This type is an instance of the IsString class. If you use the
OverloadedStrings language extension and want to write a
prefix-matching pattern as a literal string, do so by suffixing
it with ".*", for example as follows:
"foo.*"
If a pattern written as a literal string does not end with
".*", it is assumed to be exact.
Instances
| Eq Pattern Source # | |
| Data Pattern Source # | |
Defined in Data.Configurator.Types.Internal Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Pattern -> c Pattern gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Pattern dataTypeOf :: Pattern -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Pattern) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Pattern) gmapT :: (forall b. Data b => b -> b) -> Pattern -> Pattern gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Pattern -> r gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Pattern -> r gmapQ :: (forall d. Data d => d -> u) -> Pattern -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> Pattern -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> Pattern -> m Pattern gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Pattern -> m Pattern gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Pattern -> m Pattern | |
| Show Pattern Source # | |
| IsString Pattern Source # | |
Defined in Data.Configurator.Types.Internal Methods fromString :: String -> Pattern | |
| Hashable Pattern Source # | |
Defined in Data.Configurator.Types.Internal | |