Enum oceanpkg::config::file::ConfigFileFmt

pub enum ConfigFileFmt {
    Toml,
    Json,
    Yaml,
}

The format of the configuration file.

Variants

Toml

Tom's Obvious, Minimal Language.

Extension: toml

Json

JavaScript Object Notation.

Extension: json

Yaml

YAML Ain't Markup Language.

Extensions: yaml, yml

Methods

impl ConfigFileFmt

pub fn from_bytes(bytes: &[u8]) -> Option<Self>

Returns the corresponding variant for the file extension, going from TOML to JSON to YAML in order.

This expects bytes to be ASCII/UTF-8 and will simply fail with other encodings.

pub fn from_path(path: &Path) -> Option<Self>

Returns the corresponding variant for the file pointed to at path based on its extension, going from TOML to JSON to YAML in order.

Trait Implementations

impl Clone for ConfigFileFmt

fn clone(&self) -> ConfigFileFmt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ConfigFileFmt

impl Debug for ConfigFileFmt

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

Formats the value using the given formatter.

impl Eq for ConfigFileFmt

impl Hash for ConfigFileFmt

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for ConfigFileFmt

fn cmp(&self, other: &ConfigFileFmt) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<ConfigFileFmt> for ConfigFileFmt

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ConfigFileFmt> for ConfigFileFmt

fn partial_cmp(&self, other: &ConfigFileFmt) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ConfigFileFmt

impl StructuralPartialEq for ConfigFileFmt