Enum XvcParamFormat

pub enum XvcParamFormat {
    Unknown,
    YAML,
    JSON,
    TOML,
}

Parsable formats of a parameter file

Variants

Unknown

The default value if we cannot infer the format somehow

YAML

Yaml files are parsed with serde_yaml

JSON

Json files are parsed with serde_json

TOML

Toml files are parsed with toml

Implementations

impl XvcParamFormat

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

Infer the (hyper)parameter file format from the file path, by checking its extension.

pub fn from_xvc_path(xvc_path: &XvcPath) -> Self

Infer the (hyper)parameter file format from the xvc_path’s extension

Trait Implementations

impl Clone for XvcParamFormat

fn clone(&self) -> XvcParamFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XvcParamFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for XvcParamFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for XvcParamFormat

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for XvcParamFormat

fn eq(&self, other: &XvcParamFormat) -> 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 PartialOrd for XvcParamFormat

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for XvcParamFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for XvcParamFormat

impl Eq for XvcParamFormat

impl StructuralPartialEq for XvcParamFormat