Skip to main content

FormatSpec

Struct FormatSpec 

Source
pub struct FormatSpec { /* private fields */ }
Expand description

A format plus the extensions it reads — one entry of Options::formats.

Accepted forms (all .into()):

  • Format::Yaml or "yaml" — default extensions
  • (Format::Yaml, ["yml", "conf"]) or ("yaml", ["yml", "conf"]) — custom extensions
  • (Format::Csv, ["csv"], "db") — custom extensions plus a TableLayout (a layout id string, a TableLayout, or a CustomLayout): every file this entry claims parses under that layout, in merge mode, tree mode and single-file path sources alike. Table sources override it; string sources stay Kv; a layout on a non-table format panics at conversion. Without this form an entry uses the format’s default layout (Format::default_layout).
  • a CustomFormat — user-defined parser with the extensions it was built with

Trait Implementations§

Source§

impl Clone for FormatSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FormatSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&str> for FormatSpec

Source§

fn from(id: &str) -> Self

Panics on an unknown format id — this is config-time code.

Source§

impl<const N: usize> From<(&str, [&str; N])> for FormatSpec

Source§

fn from((id, extensions): (&str, [&str; N])) -> Self

Panics on an unknown format id — this is config-time code.

Source§

impl<const N: usize, L: Into<TableLayout>> From<(&str, [&str; N], L)> for FormatSpec

Panics on an unknown format or layout id — this is config-time code.

Source§

fn from((id, extensions, layout): (&str, [&str; N], L)) -> Self

Converts to this type from the input type.
Source§

impl<const N: usize> From<(Format, [&str; N])> for FormatSpec

Source§

fn from((format, extensions): (Format, [&str; N])) -> Self

Converts to this type from the input type.
Source§

impl<const N: usize, L: Into<TableLayout>> From<(Format, [&str; N], L)> for FormatSpec

In a formats entry the third element is always a layout (a string must be a valid layout id — extensions have no sheet meaning). Panics on unknown ids, and on a layout for a non-table format ((Format::Yaml, ["yml"], "db")) — this is config-time code.

Source§

fn from((format, extensions, layout): (Format, [&str; N], L)) -> Self

Converts to this type from the input type.
Source§

impl From<CustomFormat> for FormatSpec

Source§

fn from(custom: CustomFormat) -> Self

Converts to this type from the input type.
Source§

impl From<Format> for FormatSpec

Source§

fn from(format: Format) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for FormatSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FormatSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.