Enum FilesizeUnit

pub enum FilesizeUnit {
    B,
    KB,
    MB,
    GB,
    TB,
    PB,
    EB,
    KiB,
    MiB,
    GiB,
    TiB,
    PiB,
    EiB,
}

All the possible filesize units for a Filesize.

This type contains both units with metric (SI) prefixes which are powers of 10 (e.g., kB = 1000 bytes) and units with binary prefixes which are powers of 2 (e.g., KiB = 1024 bytes).

The number of bytes in a FilesizeUnit can be obtained using as_bytes.

Variants

B

One byte

KB

Kilobyte = 1000 bytes

MB

Megabyte = 10⁶ bytes

GB

Gigabyte = 10⁹ bytes

TB

Terabyte = 10¹² bytes

PB

Petabyte = 10¹⁵ bytes

EB

Exabyte = 10¹⁸ bytes

KiB

Kibibyte = 1024 bytes

MiB

Mebibyte = 2²⁰ bytes

GiB

Gibibyte = 2³⁰ bytes

TiB

Tebibyte = 2⁴⁰ bytes

PiB

Pebibyte = 2⁵⁰ bytes

EiB

Exbibyte = 2⁶⁰ bytes

Implementations

impl FilesizeUnit

pub const fn as_bytes(&self) -> u64

Returns the number of bytes in a FilesizeUnit.

pub const fn as_filesize(&self) -> Filesize

Convert a FilesizeUnit to a Filesize.

To create a Filesize from a multiple of a FilesizeUnit use Filesize::from_unit.

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

Returns the symbol str for a FilesizeUnit.

The symbol is exactly the same as the enum case name in Rust code except for FilesizeUnit::KB which is kB.

Examples

assert_eq!(FilesizeUnit::B.as_str(), "B");
assert_eq!(FilesizeUnit::KB.as_str(), "kB");
assert_eq!(FilesizeUnit::KiB.as_str(), "KiB");

pub const fn is_metric(&self) -> bool

Returns true if a FilesizeUnit has a metric (SI) prefix (a power of 10).

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

pub const fn is_binary(&self) -> bool

Returns true if a FilesizeUnit has a binary prefix (a power of 2).

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

Trait Implementations

impl Clone for FilesizeUnit

fn clone(&self) -> FilesizeUnit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilesizeUnit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FilesizeUnit

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FilesizeUnit

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

Formats the value using the given formatter.

impl From<FilesizeUnit> for Filesize

fn from(unit: FilesizeUnit) -> Self

Converts to this type from the input type.

impl FromStr for FilesizeUnit

type Err = ParseFilesizeUnitError

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 PartialEq for FilesizeUnit

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

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 FilesizeUnit

impl Eq for FilesizeUnit

impl StructuralPartialEq for FilesizeUnit