Conftrack.Value

Documentation

key :: QuasiQuoter

to write values of Key easily

data Value

A generic value read from a config source, to be parsed into a more useful type (see the ConfigValue class).

Constructors

ConfigString ByteString

ConfigInteger Integer

ConfigMaybeInteger ByteString Integer

A value which may be an integer, but the source cannot say for sure, e.g. because its values are entirely untyped. Use withString to handle such cases.

ConfigOther Text Text

ConfigBool Bool

ConfigNull

Instances

Show Value

Defined in Conftrack.Value

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

data ConfigError

Constructors

ParseError Text

TypeMismatch Text Value

NotPresent Key

Shadowed

Instances

Show ConfigError

Defined in Conftrack.Value

Methods

showsPrec :: Int -> ConfigError -> ShowS

show :: ConfigError -> String

showList :: [ConfigError] -> ShowS

newtype Key

A configuration key is a non-empty list of parts. By convention, these parts are separated by dots when written, although dots withing parts are not disallowed.

For writing values easily, consider enabling the QuasiQuotes language extension to use key:

>>> [key|foo.bar|]
foo.bar

Constructors

Key (NonEmpty KeyPart)

Instances

Show Key

Defined in Conftrack.Value

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

Eq Key

Defined in Conftrack.Value

Methods

(==) :: Key -> Key -> Bool

(/=) :: Key -> Key -> Bool

Ord Key

Defined in Conftrack.Value

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

Lift Key

Defined in Conftrack.Value

Methods

lift :: Quote m => Key -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Key -> Code m Key

class ConfigValue a where

Values which can be read from a config source must implement this class

Minimal complete definition

fromConfig

Methods

fromConfig :: Value -> Either ConfigError a

prettyValue :: a -> Text

optionally, a function to pretty-print values of this type, used by the functions of Conftrack.Pretty. If not given, defaults to a's Show instance.

default prettyValue :: Show a => a -> Text

Instances

ConfigValue ByteString

Defined in Conftrack.Value

Methods

fromConfig :: Value -> Either ConfigError ByteString

prettyValue :: ByteString -> Text

ConfigValue ByteString

Defined in Conftrack.Value

Methods

fromConfig :: Value -> Either ConfigError ByteString

prettyValue :: ByteString -> Text

ConfigValue OsPath

Defined in Conftrack.Value

Methods

fromConfig :: Value -> Either ConfigError OsPath

prettyValue :: OsPath -> Text

ConfigValue Text

Defined in Conftrack.Value

Methods

fromConfig :: Value -> Either ConfigError Text

prettyValue :: Text -> Text

ConfigValue Integer

Defined in Conftrack.Value

Methods

fromConfig :: Value -> Either ConfigError Integer

prettyValue :: Integer -> Text

ConfigValue Bool

Defined in Conftrack.Value

Methods

fromConfig :: Value -> Either ConfigError Bool

prettyValue :: Bool -> Text

ConfigValue Int

Defined in Conftrack.Value

Methods

fromConfig :: Value -> Either ConfigError Int

prettyValue :: Int -> Text

ConfigValue a => ConfigValue (Maybe a)

Defined in Conftrack.Value

Methods

fromConfig :: Value -> Either ConfigError (Maybe a)

prettyValue :: Maybe a -> Text

data Origin

Constructors

forall a.ConfigValue a => Origin a Text

Instances

Show Origin

Defined in Conftrack.Value

Methods

showsPrec :: Int -> Origin -> ShowS

show :: Origin -> String

showList :: [Origin] -> ShowS

type KeyPart = Text

prefixedWith :: Key -> [KeyPart] -> Key

withString :: (ByteString -> Either ConfigError a) -> Value -> Either ConfigError a