Struct byte_unit::AdjustedByte

source ·
pub struct AdjustedByte { /* private fields */ }
Available on crate feature byte only.
Expand description

Generated from the Byte::get_adjusted_unit method or the the Byte::get_appropriate_unit method.

For accuracy representation, utilize the Byte struct.

Implementations§

source§

impl AdjustedByte

Methods for getting values.

source

pub const fn get_value(&self) -> f64

Get the value.

source

pub const fn get_unit(&self) -> Unit

Get the unit.

source

pub fn get_byte(&self) -> Byte

Create a new Byte instance from this AdjustedByte instance.

Examples
use byte_unit::{Byte, Unit};

let byte = Byte::from_u64_with_unit(1555, Unit::KB).unwrap();

let adjusted_byte = byte.get_adjusted_unit(Unit::MB);

let byte_back = adjusted_byte.get_byte();

assert_eq!(byte, byte_back);
Points to Note
  • The result may not be logically equal to the original Byte instance due to the accuracy of floating-point numbers.

Trait Implementations§

source§

impl Clone for AdjustedByte

source§

fn clone(&self) -> AdjustedByte

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for AdjustedByte

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for AdjustedByte

Available on crate feature serde only.
source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for AdjustedByte

source§

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

Formats the value using the given formatter.

Examples
use byte_unit::{Byte, Unit};

let byte = Byte::from_u64_with_unit(1555, Unit::KB).unwrap();

let adjusted_byte = byte.get_adjusted_unit(Unit::MB);

assert_eq!("1.555 MB", adjusted_byte.to_string());
use byte_unit::{Byte, UnitType};

let byte = Byte::from_u64(10000);

let adjusted_byte_based_2 = byte.get_appropriate_unit(UnitType::Binary);
let adjusted_byte_based_10 = byte.get_appropriate_unit(UnitType::Decimal);

assert_eq!("9.765625 KiB", format!("{adjusted_byte_based_2}"));
assert_eq!("10 KB", format!("{adjusted_byte_based_10}"));

// with precision
assert_eq!("9.77 KiB", format!("{adjusted_byte_based_2:.2}"));
assert_eq!("10.00 KB", format!("{adjusted_byte_based_10:.2}"));

// without any unnecessary fractional part
assert_eq!("9.77 KiB", format!("{adjusted_byte_based_2:#.2}"));
assert_eq!("10 KB", format!("{adjusted_byte_based_10:#.2}"));

// with a width, left alignment
assert_eq!("9.77   KiB", format!("{adjusted_byte_based_2:10.2}"));
assert_eq!("10.00   KB", format!("{adjusted_byte_based_10:10.2}"));

// with a width, right alignment
assert_eq!("  9.77 KiB", format!("{adjusted_byte_based_2:>10.2}"));
assert_eq!("  10.00 KB", format!("{adjusted_byte_based_10:>10.2}"));

// with a width, right alignment, more spaces between the value and the unit
assert_eq!("  9.77 KiB", format!("{adjusted_byte_based_2:>+10.2}"));
assert_eq!(" 10.00  KB", format!("{adjusted_byte_based_10:>+10.2}"));

// no spaces between the value and the unit
assert_eq!("9.765625KiB", format!("{adjusted_byte_based_2:-}"));
assert_eq!("10KB", format!("{adjusted_byte_based_10:-}"));
source§

impl From<AdjustedByte> for Byte

source§

fn from(value: AdjustedByte) -> Self

Converts to this type from the input type.
source§

impl From<AdjustedByte> for Unit

source§

fn from(value: AdjustedByte) -> Self

Converts to this type from the input type.
source§

impl From<AdjustedByte> for f64

source§

fn from(value: AdjustedByte) -> Self

Converts to this type from the input type.
source§

impl From<Byte> for AdjustedByte

source§

fn from(value: Byte) -> Self

unit_type is set to UnitType::Both. See Byte::get_appropriate_unit.

source§

impl FromStr for AdjustedByte

source§

fn from_str(s: &str) -> Result<Self, Self::Err>

§

type Err = ParseError

The associated error which can be returned from parsing.
source§

impl Ord for AdjustedByte

source§

fn cmp(&self, other: &AdjustedByte) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for AdjustedByte

source§

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

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

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.
source§

impl PartialOrd for AdjustedByte

source§

fn partial_cmp(&self, other: &AdjustedByte) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Serialize for AdjustedByte

Available on crate feature serde only.
source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Copy for AdjustedByte

source§

impl Eq for AdjustedByte

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,