mg_settings/errors/
settings.rs

1/*
2 * Copyright (c) 2017 Boucher, Antoni <bouanto@zoho.com>
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy of
5 * this software and associated documentation files (the "Software"), to deal in
6 * the Software without restriction, including without limitation the rights to
7 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
8 * the Software, and to permit persons to whom the Software is furnished to do so,
9 * subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in all
12 * copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
16 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
17 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
18 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 */
21
22//! Settings error type.
23
24use std::fmt::{self, Display, Formatter};
25
26use self::SettingError::{UnknownChoice, UnknownSetting, WrongType};
27
28/// Error when getting/setting settings.
29#[allow(missing_docs)]
30#[derive(Debug, PartialEq)]
31pub enum SettingError {
32    /// Unknown setting value choice.
33    UnknownChoice {
34        // The actual value.
35        actual: String,
36        // The list of expected values.
37        expected: Vec<&'static str>
38    },
39    /// Unknown setting name.
40    UnknownSetting(String),
41    /// Wrong value type for setting.
42    WrongType {
43        // The actual type.
44        actual: String,
45        // The expected type.
46        expected: String,
47    },
48}
49
50impl Display for SettingError {
51    fn fmt(&self, formatter: &mut Formatter) -> fmt::Result {
52        match *self {
53            UnknownChoice { ref actual, ref expected } =>
54                write!(formatter, "unknown choice {}, expecting one of: {}", actual, expected.join(", ")),
55            UnknownSetting(ref name) =>
56                write!(formatter, "no setting named {}", name),
57            WrongType { ref actual, ref expected } =>
58                write!(formatter, "wrong value type: expecting {}, but found {}", expected, actual),
59        }
60    }
61}
mg_settings/errors/settings.rs

mg_settings/errors/
settings.rs
