Conferer.Source

Public API module for Source related features

Documentation

data Source

Concrete type for IsSource

Constructors

forall s.(IsSource s, Show s) => Source s

Instances

Show Source

Defined in Conferer.Source.Internal

Methods

showsPrec :: Int -> Source -> ShowS

show :: Source -> String

showList :: [Source] -> ShowS

IsSource Source

Defined in Conferer.Source.Internal

Methods

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

getSubkeysInSource :: Source -> Key -> IO [Key]

class IsSource s where

Main interface for interacting with external systems that provide configuration which will be used by FromConfig to fetch values.

Methods

getKeyInSource :: s -> Key -> IO (Maybe Text)

This function is used by the Config to get values from this Source.

getSubkeysInSource :: s -> Key -> IO [Key]

This function is used by the Config to list possible values from the Source that if the user getKeyInSource, it will be found.

Instances

IsSource Source

Defined in Conferer.Source.Internal

Methods

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

getSubkeysInSource :: Source -> Key -> IO [Key]

IsSource InMemorySource

Defined in Conferer.Source.InMemory

Methods

getKeyInSource :: InMemorySource -> Key -> IO (Maybe Text)

getSubkeysInSource :: InMemorySource -> Key -> IO [Key]

IsSource EnvSource

Defined in Conferer.Source.Env

Methods

getKeyInSource :: EnvSource -> Key -> IO (Maybe Text)

getSubkeysInSource :: EnvSource -> Key -> IO [Key]

IsSource CLIArgsSource

Defined in Conferer.Source.CLIArgs

Methods

getKeyInSource :: CLIArgsSource -> Key -> IO (Maybe Text)

getSubkeysInSource :: CLIArgsSource -> Key -> IO [Key]

IsSource NamespacedSource

Defined in Conferer.Source.Namespaced

Methods

getKeyInSource :: NamespacedSource -> Key -> IO (Maybe Text)

getSubkeysInSource :: NamespacedSource -> Key -> IO [Key]

IsSource NullSource

Defined in Conferer.Source.Null

Methods

getKeyInSource :: NullSource -> Key -> IO (Maybe Text)

getSubkeysInSource :: NullSource -> Key -> IO [Key]

IsSource PropertiesFileSource

Defined in Conferer.Source.PropertiesFile

Methods

getKeyInSource :: PropertiesFileSource -> Key -> IO (Maybe Text)

getSubkeysInSource :: PropertiesFileSource -> Key -> IO [Key]

type SourceCreator = Config -> IO 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)

module Conferer.Key