Enum Format

#[non_exhaustive]
pub enum Format {
    None,
    Json,
    Toml,
    Yaml,
    Ron,
    Unknown,
}

Configuration serialisation formats

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

Not specified: guess from the path

Json

JavaScript Object Notation

Toml

Tom’s Obvious Minimal Language

Yaml

YAML Ain’t Markup Language

Ron

Rusty Object Notation

Unknown

Error: unable to guess format

Implementations

impl Format

pub fn guess_from_path(path: &Path) -> Format

Guess format from the path name

This does not open the file.

Potentially fallible: on error, returns Format::Unknown. This may be due to unrecognised file extension or due to the required feature not being enabled.

pub fn read_path<T>(self, path: &Path) -> Result<T, Error>

where T: DeserializeOwned,

Read from a path

pub fn write_path<T>(self, path: &Path, value: &T) -> Result<(), Error>

where T: Serialize,

Write to a path

pub fn guess_and_read_path<T>(path: &Path) -> Result<T, Error>

where T: DeserializeOwned,

Guess format and load from a path

pub fn guess_and_write_path<T>(path: &Path, value: &T) -> Result<(), Error>

where T: Serialize,

Guess format and write to a path

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Format

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Format

fn default() -> Format

Returns the “default value” for a type.

impl Display for Format

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Error for Format

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Hash for Format

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Format

fn eq(&self, other: &Format) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Format

impl Eq for Format

impl StructuralPartialEq for Format