Safe Haskell	Safe
Language	Haskell2010

Conferer.Types

Synopsis

data Source = Source {
- getKeyInSource :: Key -> IO (Maybe Text)
}
newtype Key = Path {
- unKey :: [Text]
}
keyName :: Key -> Text
data Config = Config {
- sources :: [Source]
- defaults :: Map Key Text
}
type SourceCreator = Config -> IO Source
keyNotPresentError :: forall a. Typeable a => Key -> Proxy a -> FailedToFetchError
class DefaultConfig a where
- configDef :: a
class FromConfig a where
- updateFromConfig :: Key -> Config -> a -> IO a
- fetchFromConfig :: Key -> Config -> IO (Maybe a)
class FromConfigG f where
- updateFromConfigG :: Key -> Config -> f a -> IO (f a)
- fetchFromConfigG :: Key -> Config -> IO (Maybe (f a))
data ConfigParsingError = ConfigParsingError Key Text TypeRep
data FailedToFetchError = FailedToFetchError Key TypeRep

Documentation

data Source Source #

Core interface for library provided configuration, basically consists of getting a Key and informing returning a maybe signaling the value and if it's present in that specific source

Constructors

Source
Fields getKeyInSource :: Key -> IO (Maybe Text)

newtype Key Source #

The way to index Sources, basically list of names that will be adapted to whatever the source needs

Constructors

Path
Fields unKey :: [Text]

Instances

Eq Key Source #
Instance details Defined in Conferer.Types Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Ord Key Source #
Instance details Defined in Conferer.Types Methods compare :: Key -> Key -> Ordering # (<) :: Key -> Key -> Bool # (<=) :: Key -> Key -> Bool # (>) :: Key -> Key -> Bool # (>=) :: Key -> Key -> Bool # max :: Key -> Key -> Key # min :: Key -> Key -> Key #
Show Key Source #
Instance details Defined in Conferer.Types Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
IsString Key Source #
Instance details Defined in Conferer.Types Methods fromString :: String -> Key #

keyName :: Key -> Text Source #

Collapse a key into a textual representation

data Config Source #

Core type that the user of this library interact with, in the future it may contain more this besides a list of sources

Constructors

Config
Fields sources :: [Source] defaults :: Map Key Text

type SourceCreator = Config -> IO Source Source #

The type for creating a source given a Config, some sources require a certain configuration to be initialized (for example: the redis source needs connection info to connect to the server)

keyNotPresentError :: forall a. Typeable a => Key -> Proxy a -> FailedToFetchError Source #

class DefaultConfig a where Source #

Default defining instance

Here a Nothing means that the value didn't appear in the config, some instances never return a value since they have defaults that can never fail

Methods

configDef :: a Source #

Instances

DefaultConfig (Maybe a) Source #
Instance details Defined in Conferer.FromConfig.Basics Methods configDef :: Maybe a Source #

class FromConfig a where Source #

Main typeclass for defining the way to get values from config, hiding the Text based nature of the Sources. updated using a config, so for example a Warp.Settings can get updated from a config, but that doesn't make much sense for something like an Int

You'd normally would never implement this typeclass, if you want to implement FromConfig you should implement that directly, and if you want to use DefaultConfig and FromConfig to implement FromConfig you should let the default Generics based implementation do it's thing

Minimal complete definition

Nothing

Methods

updateFromConfig :: Key -> Config -> a -> IO a Source #

updateFromConfig :: (Generic a, Typeable a, FromConfigG (Rep a)) => Key -> Config -> a -> IO a Source #

fetchFromConfig :: Key -> Config -> IO (Maybe a) Source #

fetchFromConfig :: (Generic a, FromConfigG (Rep a)) => Key -> Config -> IO (Maybe a) Source #

Instances

FromConfig Bool Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfig :: Key -> Config -> Bool -> IO Bool Source # fetchFromConfig :: Key -> Config -> IO (Maybe Bool) Source #
FromConfig Float Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfig :: Key -> Config -> Float -> IO Float Source # fetchFromConfig :: Key -> Config -> IO (Maybe Float) Source #
FromConfig Int Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfig :: Key -> Config -> Int -> IO Int Source # fetchFromConfig :: Key -> Config -> IO (Maybe Int) Source #
FromConfig Integer Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfig :: Key -> Config -> Integer -> IO Integer Source # fetchFromConfig :: Key -> Config -> IO (Maybe Integer) Source #
FromConfig String Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfig :: Key -> Config -> String -> IO String Source # fetchFromConfig :: Key -> Config -> IO (Maybe String) Source #
FromConfig ByteString Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfig :: Key -> Config -> ByteString -> IO ByteString Source # fetchFromConfig :: Key -> Config -> IO (Maybe ByteString) Source #
FromConfig Text Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfig :: Key -> Config -> Text -> IO Text Source # fetchFromConfig :: Key -> Config -> IO (Maybe Text) Source #
FromConfig a => FromConfig (Maybe a) Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfig :: Key -> Config -> Maybe a -> IO (Maybe a) Source # fetchFromConfig :: Key -> Config -> IO (Maybe (Maybe a)) Source #

class FromConfigG f where Source #

Purely Generics machinery, ignore...

Methods

updateFromConfigG :: Key -> Config -> f a -> IO (f a) Source #

fetchFromConfigG :: Key -> Config -> IO (Maybe (f a)) Source #

Instances

FromConfig inner => FromConfigG (Rec0 inner) Source #	Purely `Generics` machinery, ignore...
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfigG :: Key -> Config -> Rec0 inner a -> IO (Rec0 inner a) Source # fetchFromConfigG :: Key -> Config -> IO (Maybe (Rec0 inner a)) Source #
FromConfigG inner => FromConfigG (D1 metadata inner) Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfigG :: Key -> Config -> D1 metadata inner a -> IO (D1 metadata inner a) Source # fetchFromConfigG :: Key -> Config -> IO (Maybe (D1 metadata inner a)) Source #
(FromConfigWithConNameG inner, Constructor constructor) => FromConfigG (C1 constructor inner) Source #
Instance details Defined in Conferer.FromConfig.Basics Methods updateFromConfigG :: Key -> Config -> C1 constructor inner a -> IO (C1 constructor inner a) Source # fetchFromConfigG :: Key -> Config -> IO (Maybe (C1 constructor inner a)) Source #

data ConfigParsingError Source #

Constructors

ConfigParsingError Key Text TypeRep

Instances

Eq ConfigParsingError Source #
Instance details Defined in Conferer.Types Methods (==) :: ConfigParsingError -> ConfigParsingError -> Bool # (/=) :: ConfigParsingError -> ConfigParsingError -> Bool #
Show ConfigParsingError Source #
Instance details Defined in Conferer.Types Methods showsPrec :: Int -> ConfigParsingError -> ShowS # show :: ConfigParsingError -> String # showList :: [ConfigParsingError] -> ShowS #
Exception ConfigParsingError Source #
Instance details Defined in Conferer.Types Methods toException :: ConfigParsingError -> SomeException # fromException :: SomeException -> Maybe ConfigParsingError # displayException :: ConfigParsingError -> String #

data FailedToFetchError Source #

Constructors

FailedToFetchError Key TypeRep

Instances

Eq FailedToFetchError Source #
Instance details Defined in Conferer.Types Methods (==) :: FailedToFetchError -> FailedToFetchError -> Bool # (/=) :: FailedToFetchError -> FailedToFetchError -> Bool #
Show FailedToFetchError Source #
Instance details Defined in Conferer.Types Methods showsPrec :: Int -> FailedToFetchError -> ShowS # show :: FailedToFetchError -> String # showList :: [FailedToFetchError] -> ShowS #
Exception FailedToFetchError Source #
Instance details Defined in Conferer.Types Methods toException :: FailedToFetchError -> SomeException # fromException :: SomeException -> Maybe FailedToFetchError # displayException :: FailedToFetchError -> String #