Struct ByteLength

pub struct ByteLength(pub usize);

A length in bytes.

The value is stored in bytes, you can use associated functions to convert from other units or you can use the ByteUnits extension methods to initialize from an integer literal.

Tuple Fields

0: usize

Implementations

impl ByteLength

pub const MAX: ByteLength = _

Maximum representable byte length.

pub fn bytes(&self) -> usize

Length in bytes.

This is the same as .0.

pub fn kibis(self) -> f64

Length in kibi-bytes.

pub fn kilos(self) -> f64

Length in kilo-bytes.

pub fn mebis(self) -> f64

Length in mebi-bytes.

pub fn megas(self) -> f64

Length in mega-bytes.

pub fn gibis(self) -> f64

Length in gibi-bytes.

pub fn gigas(self) -> f64

Length in giga-bytes.

pub fn tebis(self) -> f64

Length in tebi-bytes.

pub fn teras(self) -> f64

Length in tera-bytes.

pub const fn saturating_add(self, rhs: ByteLength) -> ByteLength

Adds the two lengths without overflowing or wrapping.

pub const fn saturating_sub(self, rhs: ByteLength) -> ByteLength

Subtracts the two lengths without overflowing or wrapping.

pub const fn saturating_mul(self, rhs: ByteLength) -> ByteLength

Multiplies the two lengths without overflowing or wrapping.

pub const fn wrapping_add(self, rhs: ByteLength) -> ByteLength

Adds the two lengths wrapping overflows.

pub const fn wrapping_sub(self, rhs: ByteLength) -> ByteLength

Subtracts the two lengths wrapping overflows.

pub const fn wrapping_mul(self, rhs: ByteLength) -> ByteLength

Multiplies the two lengths wrapping overflows.

pub const fn wrapping_div(self, rhs: ByteLength) -> ByteLength

Divides the two lengths wrapping overflows.

pub fn checked_add(self, rhs: ByteLength) -> Option<ByteLength>

Adds the two lengths, returns None if the sum overflows.

pub fn checked_sub(self, rhs: ByteLength) -> Option<ByteLength>

Subtracts the two lengths, returns None if the subtraction overflows.

pub fn checked_mul(self, rhs: ByteLength) -> Option<ByteLength>

Multiplies the two lengths, returns None if the sum overflows.

pub fn checked_div(self, rhs: ByteLength) -> Option<ByteLength>

Divides the two lengths, returns None if the subtraction overflows.

impl ByteLength

Constructors

pub const fn from_byte(bytes: usize) -> Self

From bytes.

This is the same as ByteLength(bytes).

pub const fn from_kibi(kibi_bytes: usize) -> Self

From kibi-bytes.

1 kibi-byte equals 1024 bytes.

pub const fn from_kilo(kibi_bytes: usize) -> Self

From kilo-bytes.

1 kilo-byte equals 1000 bytes.

pub const fn from_mebi(mebi_bytes: usize) -> Self

From mebi-bytes.

1 mebi-byte equals 1024² bytes.

pub const fn from_mega(mebi_bytes: usize) -> Self

From mega-bytes.

1 mega-byte equals 1000² bytes.

pub const fn from_gibi(gibi_bytes: usize) -> Self

From gibi-bytes.

1 gibi-byte equals 1024³ bytes.

pub const fn from_giga(giga_bytes: usize) -> Self

From giga-bytes.

1 giga-byte equals 1000³ bytes.

pub const fn from_tebi(gibi_bytes: usize) -> Self

From tebi-bytes.

1 tebi-byte equals 1024^4 bytes.

pub const fn from_tera(tera_bytes: usize) -> Self

From tera-bytes.

1 tera-byte equals 1000^4 bytes.

impl ByteLength

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two lengths.

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two lengths.

Trait Implementations

impl Add for ByteLength

type Output = ByteLength

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for ByteLength

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for ByteLength

fn clone(&self) -> ByteLength

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteLength

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

Formats the value using the given formatter.

impl Default for ByteLength

fn default() -> ByteLength

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ByteLength

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ByteLength

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

Formats the value using the given formatter.

impl<S: Into<Factor>> Div<S> for ByteLength

type Output = ByteLength

The resulting type after applying the / operator.

fn div(self, rhs: S) -> Self

Performs the / operation.

impl<S: Into<Factor>> DivAssign<S> for ByteLength

fn div_assign(&mut self, rhs: S)

Performs the /= operation.

impl From<usize> for ByteLength

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for ByteLength

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<S: Into<Factor>> Mul<S> for ByteLength

type Output = ByteLength

The resulting type after applying the * operator.

fn mul(self, rhs: S) -> Self

Performs the * operation.

impl<S: Into<Factor>> MulAssign<S> for ByteLength

fn mul_assign(&mut self, rhs: S)

Performs the *= operation.

impl Ord for ByteLength

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for ByteLength

type Output = ByteLength

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for ByteLength

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for ByteLength

impl Eq for ByteLength

impl StructuralPartialEq for ByteLength