Skip to main content

Format

Enum Format 

Source
pub enum Format {
    Json,
    Jsonc,
    Yaml,
    Toml,
    Ini,
    Env,
    Csv,
    Excel,
    Ods,
}
Expand description

A config file format.

The variants always exist; whether a format can actually be parsed depends on the matching Cargo feature. Which extensions a format reads is part of FormatSpec.

Variants§

§

Json

§

Jsonc

§

Yaml

§

Toml

§

Ini

§

Env

§

Csv

§

Excel

Excel workbooks (xlsx/xlsm/xlsb/xls) — a binary table-shaped format; file sources only. Feature excel.

§

Ods

OpenDocument spreadsheets (ods) — a binary table-shaped format; file sources only. Feature ods.

Implementations§

Source§

impl Format

Source

pub fn from_id(id: &str) -> Option<Format>

Look a format up by its string id ("json", "jsonc", "yaml", "toml", "ini", "env", "csv", "excel", "ods").

Source

pub fn id(self) -> &'static str

The string id of this format.

Source

pub fn default_extensions(self) -> &'static [&'static str]

The extensions (without the dot) this format claims by default.

Extension matching is always case-insensitive, and a hidden file named .X is treated as having extension X (so .env matches the env extension).

Source

pub fn default_layout(self) -> TableLayout

The default TableLayout of this format: db for the spreadsheet formats (excel/ods — a sheet is a record grid unless told otherwise), kv for csv (and, vacuously, for the non-table formats, which never consult a layout).

Source

pub fn exts<I, S>(self, extensions: I) -> FormatSpec
where I: IntoIterator<Item = S>, S: Into<String>,

Pair this format with custom extensions.

Trait Implementations§

Source§

impl Clone for Format

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 Copy for Format

Source§

impl Debug for Format

Source§

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

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

impl Eq for Format

Source§

impl From<Format> for FormatSpec

Source§

fn from(format: Format) -> Self

Converts to this type from the input type.
Source§

impl From<Format> for FormatKind

Source§

fn from(format: Format) -> Self

Converts to this type from the input type.
Source§

impl Hash for Format

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Format

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 Format

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.