Struct rocket_db_pools::figment::providers::Data
[−]Expand description
A Provider
that sources values from a file or string in a given
Format
.
Constructing
A Data
provider is typically constructed indirectly via a type that
implements the Format
trait via the Format::file()
and
Format::string()
methods which in-turn defer to Data::file()
and
Data::string()
by default:
// The `Format` trait must be in-scope to use its methods.
use figment::providers::{Format, Data, Json};
// These two are equivalaent, except the former requires the explicit type.
let json = Data::<Json>::file("foo.json");
let json = Json::file("foo.json");
Provider Details
-
Profile
This provider does not set a profile.
-
Metadata
This provider is named
${NAME} file
(when constructed viaData::file()
) or${NAME} source string
(when constructed viaData::string()
), where${NAME}
isFormat::NAME
. When constructed from a file, the file’s path is specified as fileSource
. Path interpolation is unchanged from the default. -
Data (Unnested, default)
When nesting is not specified, the source file or string is read and parsed, and the parsed dictionary is emitted into the profile configurable via
Data::profile()
, which defaults toProfile::Default
. If the source is a file and the file is not present, an empty dictionary is emitted. -
Data (Nested)
When nesting is specified, the source value is exepcted to be a dictionary. It’s top-level keys are emitted as profiles, and the value corresponding to each key as the profile data.
Fields
profile: Option<Profile>
The profile data will be emitted to if nesting is disabled. Defaults to
Profile::Default
.
Implementations
impl<F> Data<F> where
F: Format,
impl<F> Data<F> where
F: Format,
pub fn file<P>(path: P) -> Data<F> where
P: AsRef<Path>,
pub fn file<P>(path: P) -> Data<F> where
P: AsRef<Path>,
Returns a Data
provider that sources its values by parsing the file at
path
as format F
. If path
is relative, the file is searched for in
the current working directory and all parent directories until the root,
and the first hit is used.
Nesting is not enabled by default; use Data::nested()
to enable
nesting.
use serde::Deserialize;
use figment::{Figment, Jail, providers::{Format, Toml}, value::Map};
#[derive(Debug, PartialEq, Deserialize)]
struct Config {
numbers: Vec<usize>,
untyped: Map<String, usize>,
}
Jail::expect_with(|jail| {
jail.create_file("Config.toml", r#"
numbers = [1, 2, 3]
[untyped]
key = 1
other = 4
"#)?;
let config: Config = Figment::from(Toml::file("Config.toml")).extract()?;
assert_eq!(config, Config {
numbers: vec![1, 2, 3],
untyped: figment::util::map!["key".into() => 1, "other".into() => 4],
});
Ok(())
});
pub fn string(string: &str) -> Data<F>
pub fn string(string: &str) -> Data<F>
Returns a Data
provider that sources its values by parsing the string
string
as format F
. Nesting is not enabled by default; use
Data::nested()
to enable nesting.
use serde::Deserialize;
use figment::{Figment, Jail, providers::{Format, Toml}, value::Map};
#[derive(Debug, PartialEq, Deserialize)]
struct Config {
numbers: Vec<usize>,
untyped: Map<String, usize>,
}
Jail::expect_with(|jail| {
let source = r#"
numbers = [1, 2, 3]
untyped = { key = 1, other = 4 }
"#;
let config: Config = Figment::from(Toml::string(source)).extract()?;
assert_eq!(config, Config {
numbers: vec![1, 2, 3],
untyped: figment::util::map!["key".into() => 1, "other".into() => 4],
});
Ok(())
});
pub fn nested(self) -> Data<F>
pub fn nested(self) -> Data<F>
Enables nesting on self
, which results in top-level keys of the
sourced data being treated as profiles.
use serde::Deserialize;
use figment::{Figment, Jail, providers::{Format, Toml}, value::Map};
#[derive(Debug, PartialEq, Deserialize)]
struct Config {
numbers: Vec<usize>,
untyped: Map<String, usize>,
}
Jail::expect_with(|jail| {
jail.create_file("Config.toml", r#"
[global.untyped]
global = 0
hi = 7
[staging]
numbers = [1, 2, 3]
[release]
numbers = [6, 7, 8]
"#)?;
// Enable nesting via `nested()`.
let figment = Figment::from(Toml::file("Config.toml").nested());
let figment = figment.select("staging");
let config: Config = figment.extract()?;
assert_eq!(config, Config {
numbers: vec![1, 2, 3],
untyped: figment::util::map!["global".into() => 0, "hi".into() => 7],
});
let config: Config = figment.select("release").extract()?;
assert_eq!(config, Config {
numbers: vec![6, 7, 8],
untyped: figment::util::map!["global".into() => 0, "hi".into() => 7],
});
Ok(())
});
pub fn profile<P>(self, profile: P) -> Data<F> where
P: Into<Profile>,
pub fn profile<P>(self, profile: P) -> Data<F> where
P: Into<Profile>,
Set the profile to emit data to when nesting is disabled.
use serde::Deserialize;
use figment::{Figment, Jail, providers::{Format, Toml}, value::Map};
#[derive(Debug, PartialEq, Deserialize)]
struct Config { value: u8 }
Jail::expect_with(|jail| {
let provider = Toml::string("value = 123").profile("debug");
let config: Config = Figment::from(provider).select("debug").extract()?;
assert_eq!(config, Config { value: 123 });
Ok(())
});
Trait Implementations
Auto Trait Implementations
impl<F> RefUnwindSafe for Data<F> where
F: RefUnwindSafe,
impl<F> Send for Data<F> where
F: Send,
impl<F> Sync for Data<F> where
F: Sync,
impl<F> Unpin for Data<F> where
F: Unpin,
impl<F> UnwindSafe for Data<F> where
F: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
Converts self
into a collection.
fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
F: FnMut(T) -> U,
A: Array<Item = U>,
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more