Cfg.Source

This module contains the type classes for generating a KeyTree representation of a configuration source. The primary purpose is to generate a "serialized" version of our Haskell type that can be easily mapped to configuration sources.

Since: 0.0.2.0

Documentation

type FetchSource (m :: Type -> Type) = KeyTree Text Text -> m (KeyTree Text Text)

This type alias represents a function that fetches values from an external configuration source and inserts them into the leaves of our KeyTree

Since: 0.0.1.0

class ConfigSource (a :: k) where

This is the instance that allows us to construct a tree representation of type a based on its structure.

Since: 0.0.1.0

Methods

configSource :: KeyTree Text Text

Since the structure of a is statically known this KeyTree can be thought of as a constant, no runtime computation required!

Instances

ConfigSource Int16

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Int32

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Int64

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Int8

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Word16

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Word32

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Word64

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Word8

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource ByteString

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource ByteString

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Text

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Text

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Integer

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource ()

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Bool

Since: 0.0.1.1

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Char

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Double

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Float

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Int

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource Word

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource (NonEmpty a :: Type)

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

(AssertTopLevelRecord (ConfigSource :: Type -> Constraint) a, DefaultSource a, Generic a, GConfigSource (Rep a)) => ConfigSource (Config a :: Type)

Since: 0.0.2.0

Defined in Cfg.Deriving.Config

Methods

configSource :: KeyTree Text Text

ConfigSource (Value a :: Type)

Base case for ConfigSource, inserts an empty map that indicates we are "expecting a value here"

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource (Vector a :: Type)

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource (Maybe a :: Type)

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource ([a] :: Type)

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

ConfigSource ((a, b) :: Type)

Since: 0.0.1.0

Defined in Cfg.Source

Methods

configSource :: KeyTree Text Text

(GetConfigOptions t, AssertTopLevelRecord (ConfigSource :: Type -> Constraint) a, Generic a, DefaultSource a, GConfigSource (Rep a)) => ConfigSource (ConfigOpts t a :: Type)

Since: 0.0.2.0

Defined in Cfg.Deriving.Config

Methods

configSource :: KeyTree Text Text

(ConfigRootOptions r f, AssertTopLevelRecord (ConfigSource :: Type -> Constraint) a, Generic a, DefaultSource a, GConfigSource (Rep a)) => ConfigSource (ConfigRoot r f a :: Type)

Since: 0.0.2.0

Defined in Cfg.Deriving.Config

Methods

configSource :: KeyTree Text Text