summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRyan Leckey <leckey.ryan@gmail.com>2019-05-09 09:55:38 -0700
committerGitHub <noreply@github.com>2019-05-09 09:55:38 -0700
commitc03fd36f4929bcb0a0bfa8ff601cb35ffb95106e (patch)
tree3a35ad844adc09cfd0a10bc5b3099bd1d8187248
parent2502fbcce7295c56efd9825a14748d98f76ef613 (diff)
parenta1eecd00447b66e98bf47b922228a714a3b06782 (diff)
Merge pull request #106 from tyranron/60-fix-defaults
Fix defaults serialization and 'invalid type: unit value' deserialization error (#60)
-rw-r--r--src/config.rs39
-rw-r--r--tests/defaults.rs36
-rw-r--r--tests/empty.rs21
3 files changed, 93 insertions, 3 deletions
diff --git a/src/config.rs b/src/config.rs
index f19e59a..fa43e2a 100644
--- a/src/config.rs
+++ b/src/config.rs
@@ -10,7 +10,7 @@ use ser::ConfigSerializer;
use source::Source;
use path;
-use value::{Value, ValueKind, ValueWithKey};
+use value::{Table, Value, ValueKind, ValueWithKey};
#[derive(Clone, Debug)]
enum ConfigKind {
@@ -49,7 +49,12 @@ pub struct Config {
impl Config {
pub fn new() -> Self {
- Config::default()
+ Self {
+ kind: ConfigKind::default(),
+ // Config root should be instantiated as an empty table
+ // to avoid deserialization errors.
+ cache: Value::new(None, Table::new()),
+ }
}
/// Merge in a configuration property source.
@@ -129,6 +134,26 @@ impl Config {
self.refresh()
}
+ /// Set the configuration defaults by serializing them from given value.
+ pub fn set_defaults<T>(&mut self, value: &T) -> Result<&mut Config>
+ where
+ T: Serialize,
+ {
+ match self.kind {
+ ConfigKind::Mutable {
+ ref mut defaults, ..
+ } => {
+ for (key, val) in Self::try_from(&value)?.collect()? {
+ defaults.insert(key.parse()?, val);
+ }
+ }
+
+ ConfigKind::Frozen => return Err(ConfigError::Frozen),
+ }
+
+ self.refresh()
+ }
+
pub fn set<T>(&mut self, key: &str, value: T) -> Result<&mut Config>
where
T: Into<Value>,
@@ -192,13 +217,21 @@ impl Config {
T::deserialize(self)
}
- /// Attempt to deserialize the entire configuration into the requested type.
+ /// Attempt to serialize the entire configuration from the given type.
pub fn try_from<T: Serialize>(from: &T) -> Result<Self> {
let mut serializer = ConfigSerializer::default();
from.serialize(&mut serializer)?;
Ok(serializer.output)
}
+ /// Attempt to serialize the entire configuration from the given type
+ /// as default values.
+ pub fn try_defaults_from<T: Serialize>(from: &T) -> Result<Self> {
+ let mut c = Self::new();
+ c.set_defaults(from)?;
+ Ok(c)
+ }
+
#[deprecated(since = "0.7.0", note = "please use 'try_into' instead")]
pub fn deserialize<'de, T: Deserialize<'de>>(self) -> Result<T> {
self.try_into()
diff --git a/tests/defaults.rs b/tests/defaults.rs
new file mode 100644
index 0000000..b00da29
--- /dev/null
+++ b/tests/defaults.rs
@@ -0,0 +1,36 @@
+extern crate config;
+
+#[macro_use]
+extern crate serde_derive;
+
+use config::*;
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct Settings {
+ pub db_host: String,
+}
+
+impl Default for Settings {
+ fn default() -> Self {
+ Settings {
+ db_host: String::from("default"),
+ }
+ }
+}
+
+#[test]
+fn set_defaults() {
+ let mut c = Config::new();
+ c.set_defaults(&Settings::default())
+ .expect("Setting defaults failed");
+ let s: Settings = c.try_into().expect("Deserialization failed");
+
+ assert_eq!(s.db_host, "default");
+}
+
+#[test]
+fn try_from_defaults() {
+ let c = Config::try_from(&Settings::default()).expect("Serialization failed");
+ let s: Settings = c.try_into().expect("Deserialization failed");
+ assert_eq!(s.db_host, "default");
+}
diff --git a/tests/empty.rs b/tests/empty.rs
new file mode 100644
index 0000000..1f56d38
--- /dev/null
+++ b/tests/empty.rs
@@ -0,0 +1,21 @@
+extern crate config;
+
+#[macro_use]
+extern crate serde_derive;
+
+use config::*;
+
+#[derive(Debug, Serialize, Deserialize)]
+struct Settings {
+ #[serde(skip)]
+ foo: isize,
+ #[serde(skip)]
+ bar: u8,
+}
+
+#[test]
+fn empty_deserializes() {
+ let s: Settings = Config::new().try_into().expect("Deserialization failed");
+ assert_eq!(s.foo, 0);
+ assert_eq!(s.bar, 0);
+}