Struct xbytes::ByteSize

pub struct ByteSize(/* private fields */);

Implementations

impl ByteSize

pub fn of(value: impl Into<Float>, unit: Unit) -> Self

Create a ByteSize from a value and unit

use xbytes::prelude::*;

let size = ByteSize::of(10, MEBI_BYTE);
assert_eq!(size.to_string(), "10 MiB");

let a = ByteSize::of(1.2, GIGA_BYTE);
let b = ByteSize::of(1.3, GIGA_BYTE);
assert_eq!((a + b).repr(Mode::Decimal).to_string(), "2.50 GB");

pub const fn from_bytes(value: Int) -> Self

pub const fn from_bits(value: Int) -> Result<Self, ParseError>

pub const fn bytes(&self) -> Int

pub const fn bits(&self) -> Result<Int, ParseError>

pub fn repr(&self, mode: Mode) -> ByteSizeRepr

pub fn repr_as(&self, unit: impl Into<Unit>) -> ByteSizeRepr

Trait Implementations

impl Add for ByteSize

type Output = ByteSize

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for ByteSize

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for ByteSize

fn clone(&self) -> ByteSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteSize

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

Formats the value using the given formatter.

impl Display for ByteSize

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

Formats the value using the given formatter.

impl<T: TryInto<Int>> Div<T> for ByteSize

type Output = ByteSize

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: TryInto<Int>> DivAssign<T> for ByteSize

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<ByteSizeRepr> for ByteSize

fn from(repr: ByteSizeRepr) -> Self

Converts to this type from the input type.

impl FromStr for ByteSize

type Err = ParseError

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

type Output = ByteSize

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: TryInto<Int>> MulAssign<T> for ByteSize

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ByteSize

fn eq(&self, other: &ByteSize) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method 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

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for ByteSize

type Output = ByteSize

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for ByteSize

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for ByteSize

impl Eq for ByteSize

impl StructuralEq for ByteSize

impl StructuralPartialEq for ByteSize