Struct ByteSize 

pub struct ByteSize(pub u64);

Re-export of the bytesize crate if the bytesize feature is enabled. Byte size representation.

Tuple Fields

0: u64

Implementations

impl ByteSize

pub const fn b(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of bytes.

pub const fn kb(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of kilobytes.

pub const fn kib(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of kibibytes.

pub const fn mb(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of megabytes.

pub const fn mib(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of mebibytes.

pub const fn gb(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of gigabytes.

pub const fn gib(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of gibibytes.

pub const fn tb(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of terabytes.

pub const fn tib(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of tebibytes.

pub const fn pb(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of petabytes.

pub const fn pib(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of pebibytes.

pub const fn eb(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of exabytes.

pub const fn eib(size: u64) -> ByteSize

Constructs a byte size wrapper from a quantity of exbibytes.

pub const fn as_u64(&self) -> u64

Returns byte count.

pub fn as_kb(&self) -> f64

Returns byte count as kilobytes.

pub fn as_kib(&self) -> f64

Returns byte count as kibibytes.

pub fn as_mb(&self) -> f64

Returns byte count as megabytes.

pub fn as_mib(&self) -> f64

Returns byte count as mebibytes.

pub fn as_gb(&self) -> f64

Returns byte count as gigabytes.

pub fn as_gib(&self) -> f64

Returns byte count as gibibytes.

pub fn as_tb(&self) -> f64

Returns byte count as terabytes.

pub fn as_tib(&self) -> f64

Returns byte count as tebibytes.

pub fn as_pb(&self) -> f64

Returns byte count as petabytes.

pub fn as_pib(&self) -> f64

Returns byte count as pebibytes.

pub fn as_eb(&self) -> f64

Returns byte count as exabytes.

pub fn as_eib(&self) -> f64

Returns byte count as exbibytes.

pub fn display(&self) -> Display

Returns a formatting display wrapper.

Trait Implementations

impl Add for ByteSize

type Output = ByteSize

The resulting type after applying the + operator.

fn add(self, rhs: ByteSize) -> ByteSize

Performs the + operation.

impl<T> Add<T> for ByteSize

where T: Into<u64>,

type Output = ByteSize

The resulting type after applying the + operator.

fn add(self, rhs: T) -> ByteSize

Performs the + operation.

impl AddAssign for ByteSize

fn add_assign(&mut self, rhs: ByteSize)

Performs the += operation.

impl<T> AddAssign<T> for ByteSize

where T: Into<u64>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for ByteSize

fn clone(&self) -> ByteSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ByteSize

impl Debug for ByteSize

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

Formats the value using the given formatter.

impl Default for ByteSize

fn default() -> ByteSize

Returns the “default value” for a type.

impl Display for ByteSize

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

Formats the value using the given formatter.

impl EnvParsePrimitive for ByteSize

fn parse(val: &str) -> Result<Self, BoxError>

Parses a string value into the implementing type.

fn parse_from_env_var( var_name: impl AsRef<str>, default: Option<&str>, ) -> Result<Self, EnvStructError>

where Self: Sized,

Parses an environment variable into the implementing type.

fn get_env_entries( prefix: impl AsRef<str>, default: Option<&str>, ) -> Result<Vec<EnvEntry>, EnvStructError>

Retrieves environment variable entries for documentation purposes.

impl Eq for ByteSize

impl FromStr for ByteSize

type Err = String

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<ByteSize, <ByteSize as FromStr>::Err>

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

impl Hash for ByteSize

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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<T> Mul<T> for ByteSize

where T: Into<u64>,

type Output = ByteSize

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> ByteSize

Performs the * operation.

impl<T> MulAssign<T> for ByteSize

where T: Into<u64>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Ord for ByteSize

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

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

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

impl Sub for ByteSize

type Output = ByteSize

The resulting type after applying the - operator.

fn sub(self, rhs: ByteSize) -> ByteSize

Performs the - operation.

impl<T> Sub<T> for ByteSize

where T: Into<u64>,

type Output = ByteSize

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> ByteSize

Performs the - operation.

impl SubAssign for ByteSize

fn sub_assign(&mut self, rhs: ByteSize)

Performs the -= operation.

impl<T> SubAssign<T> for ByteSize

where T: Into<u64>,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.