summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2021-06-03 18:17:16 +0200
committerGitHub <noreply@github.com>2021-06-03 18:17:16 +0200
commit7645a013c9b97c095c24b5bf749c1e10d4deade6 (patch)
tree0a1a1b82709498d5b2f744c2548c04503d7dac44
parent3e5cae69c4a0057ed523df2e8d42db83f7e684ba (diff)
parent8756dd05307aae6edf78d6fc946d42c602808f64 (diff)
Merge pull request #208 from mjte-riot/valuekind-pub
ValueKind is now public to users of the crate
-rw-r--r--src/lib.rs1
-rw-r--r--src/value.rs4
2 files changed, 5 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 0725189..60d7012 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -71,3 +71,4 @@ pub use crate::error::ConfigError;
pub use crate::file::{File, FileFormat, FileSourceFile, FileSourceString};
pub use crate::source::Source;
pub use crate::value::Value;
+pub use crate::value::ValueKind;
diff --git a/src/value.rs b/src/value.rs
index 6a2af76..8db5fcc 100644
--- a/src/value.rs
+++ b/src/value.rs
@@ -7,6 +7,10 @@ use serde::de::{Deserialize, Deserializer, Visitor};
use crate::error::*;
/// Underlying kind of the configuration value.
+///
+/// Standard operations on a `Value` by users of this crate do not require
+/// knowledge of `ValueKind`. Introspection of underlying kind is only required
+/// when the configuration values are unstructured or do not have known types.
#[derive(Debug, Clone, PartialEq)]
pub enum ValueKind {
Nil,