Config.Schema.Load

This module automates the extraction of a decoded value from a configuration value according to a specification as built using Config.Schema.Spec.

Documentation

loadValue

Arguments

:: ValueSpecs a

specification

-> Value p

value

-> Either (NonEmpty (LoadError p)) a

errors or decoded value

Match a Value against a ValueSpecs and return either the interpretation of that value or the list of errors encountered.

loadValueFromFile

Arguments

:: ValueSpecs a

specification

-> FilePath

filename

-> IO a

Read a configuration file, parse it, and validate it according to the given specification.

Throws IOError, ParseError, or SchemaError

Errors

newtype SchemaError

Newtype wrapper for schema load errors.

Constructors

SchemaError (NonEmpty (LoadError Position))

Instances

Show SchemaError

Methods

showsPrec :: Int -> SchemaError -> ShowS

show :: SchemaError -> String

showList :: [SchemaError] -> ShowS

Exception SchemaError

Custom displayException implementation

Methods

toException :: SchemaError -> SomeException

fromException :: SomeException -> Maybe SchemaError

displayException :: SchemaError -> String

data LoadError p

Type for errors that can be encountered while decoding a value according to a specification. The error includes a key path indicating where in the configuration file the error occurred.

Constructors

LoadError p [Text] Problem

position, path, problem

Instances

Read p => Read (LoadError p)

Methods

readsPrec :: Int -> ReadS (LoadError p)

readList :: ReadS [LoadError p]

readPrec :: ReadPrec (LoadError p)

readListPrec :: ReadPrec [LoadError p]

Show p => Show (LoadError p)

Methods

showsPrec :: Int -> LoadError p -> ShowS

show :: LoadError p -> String

showList :: [LoadError p] -> ShowS

data Problem

Problems that can be encountered when matching a Value against a ValueSpecs.

Constructors

MissingSection Text

missing section name

UnusedSection Text

unused section names

SpecMismatch Text

failed specification name

Instances

Eq Problem

Methods

(==) :: Problem -> Problem -> Bool

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

Ord Problem

Methods

compare :: Problem -> Problem -> Ordering

(<) :: Problem -> Problem -> Bool

(<=) :: Problem -> Problem -> Bool

(>) :: Problem -> Problem -> Bool

(>=) :: Problem -> Problem -> Bool

max :: Problem -> Problem -> Problem

min :: Problem -> Problem -> Problem

Read Problem

Methods

readsPrec :: Int -> ReadS Problem

readList :: ReadS [Problem]

readPrec :: ReadPrec Problem

readListPrec :: ReadPrec [Problem]

Show Problem

Methods

showsPrec :: Int -> Problem -> ShowS

show :: Problem -> String

showList :: [Problem] -> ShowS