Struct NumBytes 

pub struct NumBytes {
    pub raw: u64,
}

Represents a number of bytes.

Fields

raw: u64

Raw number of bytes.

Implementations

impl NumBytes

pub const fn new(raw: u64) -> Self

Construct NumBytes from the provided raw number of bytes.

impl NumBytes

pub const fn from_usize(n: usize) -> Self

Construct NumBytes from the provided raw number of bytes.

pub const fn to_bits(self) -> NumBits

Convert the number of bytes to a number of bits.

pub const fn to_blocks_floor(self, block_size: NumBytes) -> NumBlocks

Compute a number of blocks rounding down.

pub const fn to_blocks_ceil(self, block_size: NumBytes) -> NumBlocks

Compute a number of blocks rounding up.

pub const fn split_fractional(self, unit: ByteUnit) -> (u64, u64)

Splits the number into a whole and a fractional part based on the provided unit.

pub const fn display_unit(self) -> ByteUnit

Unit to use when displaying the number.

pub const fn parse_str(s: &str) -> Result<NumBytes, NumBytesParseError>

Parse a byte size string.

pub const fn parse_ascii(buffer: &[u8]) -> Result<NumBytes, NumBytesParseError>

Parse a byte size ASCII string.

impl NumBytes

pub const fn bytes(n: u64) -> Self

Construct NumBytes from the given number n of bytes.

pub const fn kilobytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Kilobytes.

pub const fn kibibytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Kibibytes.

pub const fn megabytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Megabytes.

pub const fn mebibytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Mebibytes.

pub const fn gigabytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Gigabytes.

pub const fn gibibytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Gibibytes.

pub const fn terabytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Terabytes.

pub const fn tebibytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Tebibytes.

pub const fn petabytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Petabytes.

pub const fn pebibytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Pebibytes.

pub const fn exabytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Exabytes.

pub const fn exbibytes(n: u64) -> NumBytes

Construct NumBytes from the given number n of Exbibytes.

Trait Implementations

impl Add<NumBits> for NumBytes

type Output = NumBits

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<NumBytes> for NumBits

type Output = NumBits

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u64> for NumBytes

type Output = NumBytes

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for NumBytes

type Output = NumBytes

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<NumBytes> for NumBits

fn add_assign(&mut self, rhs: NumBytes)

Performs the += operation.

impl AddAssign<u64> for NumBytes

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl AddAssign for NumBytes

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for NumBytes

fn clone(&self) -> NumBytes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumBytes

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

Formats the value using the given formatter.

impl Display for NumBytes

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

Formats the value using the given formatter.

impl Div<u64> for NumBytes

type Output = NumBytes

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self::Output

Performs the / operation.

impl Div for NumBytes

type Output = NumBytes

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<u64> for NumBytes

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl DivAssign for NumBytes

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<ByteUnit> for NumBytes

fn from(value: ByteUnit) -> Self

Converts to this type from the input type.

impl From<NumBytes> for NumBits

fn from(value: NumBytes) -> Self

Converts to this type from the input type.

impl FromStr for NumBytes

type Err = NumBytesParseError

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 NumBytes

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 Mul<u64> for NumBytes

type Output = NumBytes

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self::Output

Performs the * operation.

impl Mul for NumBytes

type Output = NumBytes

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<u64> for NumBytes

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

impl MulAssign for NumBytes

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Ord for NumBytes

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

fn eq(&self, other: &NumBits) -> 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 PartialEq<NumBytes> for NumBits

fn eq(&self, other: &NumBytes) -> 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 PartialEq<NumBytes> for u64

fn eq(&self, other: &NumBytes) -> 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 PartialEq<u64> for NumBytes

fn eq(&self, other: &u64) -> 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 PartialEq for NumBytes

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

fn partial_cmp(&self, other: &NumBits) -> 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 PartialOrd<NumBytes> for NumBits

fn partial_cmp(&self, other: &NumBytes) -> 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 PartialOrd<NumBytes> for u64

fn partial_cmp(&self, other: &NumBytes) -> 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 PartialOrd<u64> for NumBytes

fn partial_cmp(&self, other: &u64) -> 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 PartialOrd for NumBytes

fn partial_cmp(&self, other: &NumBytes) -> 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 Sub<NumBits> for NumBytes

type Output = NumBits

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<NumBytes> for NumBits

type Output = NumBits

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<u64> for NumBytes

type Output = NumBytes

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for NumBytes

type Output = NumBytes

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<NumBytes> for NumBits

fn sub_assign(&mut self, rhs: NumBytes)

Performs the -= operation.

impl SubAssign<u64> for NumBytes

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl SubAssign for NumBytes

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for NumBytes

impl Eq for NumBytes

impl StructuralPartialEq for NumBytes