Enum FilesizeUnitFormat

pub enum FilesizeUnitFormat {
    Metric,
    Binary,
    Unit(FilesizeUnit),
}

The different file size unit display formats for a FilesizeFormatter.

To see more information about each possible format, see the documentation for each of the enum cases of FilesizeUnitFormat.

Variants

Metric

Metric will make a FilesizeFormatter use the largest_metric_unit of a Filesize when formatting it.

Binary

Binary will make a FilesizeFormatter use the largest_binary_unit of a Filesize when formatting it.

Unit(FilesizeUnit)

FilesizeUnitFormat::Unit will make a FilesizeFormatter use the provided FilesizeUnit when formatting all Filesizes.

Implementations

impl FilesizeUnitFormat

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

Returns a string representation of a FilesizeUnitFormat.

The returned string is the same exact string needed for a successful call to parse for a FilesizeUnitFormat.

Examples

assert_eq!(FilesizeUnitFormat::Metric.as_str(), "metric");
assert_eq!(FilesizeUnitFormat::Binary.as_str(), "binary");
assert_eq!(FilesizeUnitFormat::Unit(FilesizeUnit::KB).as_str(), "kB");
assert_eq!(FilesizeUnitFormat::Metric.as_str().parse(), Ok(FilesizeUnitFormat::Metric));

pub const fn is_metric(&self) -> bool

Returns true for [DisplayFilesizeUnit::Metric] or if the underlying FilesizeUnit is metric according to FilesizeUnit::is_metric.

Note that this returns true for FilesizeUnit::B as well.

pub const fn is_binary(&self) -> bool

Returns true for [DisplayFilesizeUnit::Binary] or if the underlying FilesizeUnit is binary according to FilesizeUnit::is_binary.

Note that this returns true for FilesizeUnit::B as well.

Trait Implementations

impl Clone for FilesizeUnitFormat

fn clone(&self) -> FilesizeUnitFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilesizeUnitFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FilesizeUnitFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FilesizeUnitFormat

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

Formats the value using the given formatter.

impl From<FilesizeUnit> for FilesizeUnitFormat

fn from(unit: FilesizeUnit) -> Self

Converts to this type from the input type.

impl FromStr for FilesizeUnitFormat

type Err = ParseFilesizeUnitFormatError

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 FilesizeUnitFormat

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 IntoValue for FilesizeUnitFormat

fn into_value(self, span: Span) -> Value

Converts the given value to a Value.

impl PartialEq for FilesizeUnitFormat

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

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 FilesizeUnitFormat

impl Eq for FilesizeUnitFormat

impl StructuralPartialEq for FilesizeUnitFormat