Enum Encoding

#[non_exhaustive]
pub enum Encoding {
    Json,
    Yaml,
    Toml,
    Json5,
    Csv,
    QueryString,
    Xml,
    Text,
    Gron,
    Hcl,
}

Encodings supported by this crate.

Not all of the supported encodings are supported to serialize and deserialize into. Some, like hjson only allow deserialization of encoded data but are not able to serialize back into the original representation.

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.

Json

JavaScript Object Notation

Yaml

Yet Another Markup Language

Toml

TOML configuration format

Json5

ES5 JSON

Csv

Comma separated values

QueryString

URL query string

Xml

Extensible Markup Language

Text

Plaintext document

Gron

Gron

Hcl

HCL

Implementations

impl Encoding

pub fn from_path<P>(path: P) -> Option<Encoding>

where P: AsRef<Path>,

Creates an Encoding from a path by looking at the file extension.

Returns None if the extension is absent or if the extension does not match any of the supported encodings.

pub fn from_first_line(line: &str) -> Option<Encoding>

Tries to detect the Encoding by looking at the first line of the input.

Returns None if the encoding cannot be detected from the first line.

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

Returns the name of the Encoding.

Trait Implementations

impl ArgEnum for Encoding

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.

fn to_possible_value<'a>(&self) -> Option<PossibleValue<'a>>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

impl Clone for Encoding

fn clone(&self) -> Encoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Encoding

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

Formats the value using the given formatter.

impl Display for Encoding

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

Formats the value using the given formatter.

impl PartialEq for Encoding

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

impl StructuralPartialEq for Encoding