pub struct Yaml;
Available on crate feature
yaml
only.Expand description
Static constructor methods on Yaml
return a
Data
value with a generic marker of Yaml
.
Thus, further use occurs via methods on Data
.
use figment::providers::{Format, Yaml};
// Source directly from a source string...
let provider = Yaml::string("source-string");
// Or read from a file on disk.
let provider = Yaml::file("path-to-file");
// Or configured as nested (via Data::nested()):
let provider = Yaml::file("path-to-file").nested();
See also serde_yaml::from_str
for parsing details.
Trait Implementations
sourceimpl Format for Yaml
impl Format for Yaml
sourcefn from_str<'de, T: DeserializeOwned>(s: &'de str) -> Result<T, Error>
fn from_str<'de, T: DeserializeOwned>(s: &'de str) -> Result<T, Error>
Parses
string
as the data format Self
as a T
or returns an error
if the string
is an invalid T
. Note: This method is not
intended to be called directly. Instead, it is intended to be
implemented and then used indirectly via the Data::file()
or
Data::string()
methods. Read moresourcefn file<P: AsRef<Path>>(path: P) -> Data<Self>
fn file<P: AsRef<Path>>(path: P) -> Data<Self>
Returns a
Data
provider that sources its values by parsing the file at
path
as format Self
. See Data::file()
for more details. The
default implementation calls Data::file(path)
. Read moresourcefn string(string: &str) -> Data<Self>
fn string(string: &str) -> Data<Self>
Returns a
Data
provider that sources its values by parsing string
as
format Self
. See Data::string()
for more details. The default
implementation calls Data::string(string)
. Read moresourcefn from_path<T: DeserializeOwned>(path: &Path) -> Result<T, Self::Error>
fn from_path<T: DeserializeOwned>(path: &Path) -> Result<T, Self::Error>
Parses the file at
path
as the data format Self
as a T
or returns
an error if the string
is an invalid T
. The default implementation
calls Format::from_str()
with the contents of the file. Note:
This method is not intended to be called directly. Instead, it is
intended to be implemented on special occasions and then used
indirectly via the Data::file()
or Data::string()
methods. Read moreAuto Trait Implementations
impl RefUnwindSafe for Yaml
impl Send for Yaml
impl Sync for Yaml
impl Unpin for Yaml
impl UnwindSafe for Yaml
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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