valid_toml 0.0.2

Provides the ability to load a TOML file with validation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

/* Copyright 2016 Joshua Gentry
 *
 * Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 * http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
 * <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
 * option. This file may not be copied, modified, or distributed
 * except according to those terms.
 */
use std::fmt::{Display, Formatter, Error};

//*************************************************************************************************
/// Defines the possible warnings.
#[derive(Debug)]
pub enum Warning
{
    //---------------------------------------------------------------------------------------------
    /// An optional value was not found.  The default value will be used instead.
    Missing(String),

    //---------------------------------------------------------------------------------------------
    /// An value was read from the TOML file that does not contain a definition.  Includes the
    /// name of the item.
    Undefined(String)
}

impl Display for Warning
{
    //*********************************************************************************************
    /// Display a nice message for the warning.
    fn fmt(
        &self,
        fmt : &mut Formatter
        ) -> Result<(), Error>
    {
        match *self
        {
            Warning::Missing(ref name)   => write!(fmt, "{} is not defined, using the default value.", name),
            Warning::Undefined(ref name) => write!(fmt, "{} is not a known ID and will be ignored.", name)
        }
    }
}