Copyright	(c) Eric Mertens 2017
License	ISC
Maintainer	emertens@gmail.com
Safe Haskell	None
Language	Haskell2010

Config.Schema.Load

Contents

Errors

Description

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

Synopsis

Documentation

loadValue Source #

Arguments

:: ValueSpecs a	specification
-> Value	value
-> Either [LoadError] a	error or decoded value

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

Errors

data LoadError Source #

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 [Text] Problem

path to problem and problem description

Instances

Eq LoadError Source #
Methods (==) :: LoadError -> LoadError -> Bool # (/=) :: LoadError -> LoadError -> Bool #
Ord LoadError Source #
Methods compare :: LoadError -> LoadError -> Ordering # (<) :: LoadError -> LoadError -> Bool # (<=) :: LoadError -> LoadError -> Bool # (>) :: LoadError -> LoadError -> Bool # (>=) :: LoadError -> LoadError -> Bool # max :: LoadError -> LoadError -> LoadError # min :: LoadError -> LoadError -> LoadError #
Read LoadError Source #
Methods readsPrec :: Int -> ReadS LoadError # readList :: ReadS [LoadError] # readPrec :: ReadPrec LoadError # readListPrec :: ReadPrec [LoadError] #
Show LoadError Source #
Methods showsPrec :: Int -> LoadError -> ShowS # show :: LoadError -> String # showList :: [LoadError] -> ShowS #

data Problem Source #

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

Constructors

MissingSection Text	missing section name
UnusedSections [Text]	unused section names
SpecMismatch Text	failed specification name

Instances

Eq Problem Source #
Methods (==) :: Problem -> Problem -> Bool # (/=) :: Problem -> Problem -> Bool #
Ord Problem Source #
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 Source #
Methods readsPrec :: Int -> ReadS Problem # readList :: ReadS [Problem] # readPrec :: ReadPrec Problem # readListPrec :: ReadPrec [Problem] #
Show Problem Source #
Methods showsPrec :: Int -> Problem -> ShowS # show :: Problem -> String # showList :: [Problem] -> ShowS #