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 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
use crate::{ConfigurationPath, ConfigurationSection, Value};
use cfg_if::cfg_if;
use tokens::ChangeToken;
cfg_if! {
if #[cfg(feature = "async")] {
/// Defines the behavior of a configuration.
pub trait Configuration: Send + Sync {
/// Gets the configuration value.
///
/// # Arguments
///
/// * `key` - The configuration key
fn get(&self, key: &str) -> Option<Value>;
/// Gets a [`ConfigurationSection`](crate::ConfigurationSection) with the specified key.
fn section(&self, key: &str) -> Box<dyn ConfigurationSection>;
/// Gets the sequence of [`ConfigurationSection`](crate::ConfigurationSection) children.
fn children(&self) -> Vec<Box<dyn ConfigurationSection>>;
/// Returns a [`ChangeToken`](tokens::ChangeToken) that can be used to observe when this configuration is reloaded.
fn reload_token(&self) -> Box<dyn ChangeToken>;
/// Attempts to convert the [`Configuration`] as a [`ConfigurationSection`](crate::ConfigurationSection).
fn as_section(&self) -> Option<&dyn ConfigurationSection> {
None
}
/// Gets an iterator of the key/value pairs within the [`Configuration`].
///
/// # Arguments
///
/// * `path` - The type of [`ConfigurationPath`] used when iterating
fn iter(&self, path: Option<ConfigurationPath>) -> Box<dyn Iterator<Item = (String, Value)>>;
}
} else {
/// Defines the behavior of a configuration.
pub trait Configuration {
/// Gets the configuration value.
///
/// # Arguments
///
/// * `key` - The configuration key
fn get(&self, key: &str) -> Option<Value>;
/// Gets a [`ConfigurationSection`](crate::ConfigurationSection) with the specified key.
fn section(&self, key: &str) -> Box<dyn ConfigurationSection>;
/// Gets the sequence of [`ConfigurationSection`](crate::ConfigurationSection) children.
fn children(&self) -> Vec<Box<dyn ConfigurationSection>>;
/// Returns a [`ChangeToken`](tokens::ChangeToken) that can be used to observe when this configuration is reloaded.
fn reload_token(&self) -> Box<dyn ChangeToken>;
/// Attempts to convert the [`Configuration`] as a [`ConfigurationSection`](crate::ConfigurationSection).
fn as_section(&self) -> Option<&dyn ConfigurationSection> {
None
}
/// Gets an iterator of the key/value pairs within the [`Configuration`].
///
/// # Arguments
///
/// * `path` - The type of [`ConfigurationPath`] used when iterating
fn iter(&self, path: Option<ConfigurationPath>) -> Box<dyn Iterator<Item = (String, Value)>>;
}
}
}
/// Represents an iterator of key/value pairs for a [`Configuration`].
pub struct ConfigurationIterator {
stack: Vec<Box<dyn ConfigurationSection>>,
first: Option<(String, Value)>,
prefix_length: usize,
}
impl ConfigurationIterator {
/// Initializes a new configuration iterator.
///
/// # Arguments
///
/// * `configuration` - The [`Configuration`] to iterate
/// * `path` - The type of [`ConfigurationPath`] used when iterating
pub fn new(configuration: &dyn Configuration, path: ConfigurationPath) -> Self {
let stack = configuration.children();
let mut first = None;
let mut prefix_length = 0;
if let Some(root) = configuration.as_section() {
if path == ConfigurationPath::Relative {
prefix_length = root.path().len() + 1;
} else {
let key = root.path()[prefix_length..].to_owned();
let value = root.value();
first = Some((key, value));
}
}
Self {
stack,
first,
prefix_length,
}
}
}
impl Iterator for ConfigurationIterator {
type Item = (String, Value);
fn next(&mut self) -> Option<Self::Item> {
if let Some(first) = self.first.take() {
return Some(first);
}
while let Some(config) = self.stack.pop() {
self.stack.extend(config.children().into_iter());
if let Some(section) = config.as_section() {
let key = section.path()[self.prefix_length..].to_owned();
let value = section.value();
return Some((key, value));
}
}
None
}
}