Enum Format 

#[non_exhaustive]
pub enum Format {
    Amd64,
    Win32,
    Xml,
}

An enum used to specify input/output formats

Default

Amd64

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.

Amd64

64bit hkx

Win32

32bit hkx

Xml

XML

Implementations

impl Format

pub const fn as_extension(&self) -> &str

Return the file extension corresponding to the format.

Examples

use serde_hkx_features::convert::Format;

assert_eq!(Format::Amd64.as_extension(), "hkx");
assert_eq!(Format::Win32.as_extension(), "hkx");
assert_eq!(Format::Xml.as_extension(), "xml");

pub fn from_current_format<P>(path: P) -> Result<Self>

where P: AsRef<Path>,

Return current path format of this path.

Examples

use serde_hkx_features::convert::Format;

assert_eq!(Format::from_current_format("amd64.hkx").unwrap(), Format::Amd64);
assert_eq!(Format::from_current_format("win32.hkx").unwrap(), Format::Win32);
assert_eq!(Format::from_current_format("example.xml").unwrap(), Format::Xml);

When enable extra_fmt feature.

• json -> Self::Json
• yaml -> Self::Yaml

Internally, when the file extension is .hkx, the first 17 bytes of the file are examined to determine the architecture.

Errors

In the case of unsupported file extensions or invalid hkx files.

pub fn infer_output_from_input<P>(path: P) -> Result<Self>

where P: AsRef<Path>,

Return output format from input path.

Examples

use serde_hkx_features::convert::Format;

assert_eq!(Format::infer_output_from_input("example.hkx").unwrap(), Format::Xml);
assert_eq!(Format::infer_output_from_input("example.xml").unwrap(), Format::Amd64);

When enable extra_fmt feature.

• json, yaml -> Self::Amd64

Errors

Unknown extension.

pub fn from_extension<S>(ext: S) -> Result<Self>

where S: AsRef<OsStr>,

Determine format from extension.

Examples

use serde_hkx_features::convert::Format;

assert_eq!(Format::from_extension("hkx").unwrap(), Format::Amd64);
assert_eq!(Format::from_extension("xml").unwrap(), Format::Xml);

When enable extra_fmt feature.

• json -> Self::Json
• toml -> Self::Toml
• yaml -> Self::Yaml

Errors

Unknown extension.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl Default for Format

fn default() -> Format

Returns the “default value” for a type.

impl Display for Format

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

Formats the value using the given formatter.

impl FromStr for Format

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Format

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Format

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

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

fn partial_cmp(&self, other: &Format) -> 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 ValueEnum for Format

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

All possible argument values, in display order.

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

The canonical argument value.

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

Parse an argument into Self.

impl Copy for Format

impl Eq for Format

impl StructuralPartialEq for Format