Struct byte_unit::AdjustedByte

pub struct AdjustedByte { /* fields omitted */ }

Generated from the get_appropriate_unit and get_adjusted_unit methods of a Byte object.

Implementations

impl AdjustedByte

pub fn format(&self, fractional_digits: usize) -> String

Format the AdjustedByte object to string.

Examples

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let byte = Byte::from_unit(1555f64, ByteUnit::KB).unwrap();

let result = byte.get_appropriate_unit(false).format(3);

assert_eq!("1.555 MB", result);

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let byte = Byte::from_unit(1555.2f64, ByteUnit::B).unwrap();

let result = byte.get_adjusted_unit(ByteUnit::B).format(3);

assert_eq!("1555 B", result);

pub fn get_value(&self) -> f64

pub fn get_unit(&self) -> ByteUnit

pub fn get_byte(&self) -> Byte

Create a new Byte object from this AdjustedByte object. Accuracy should be taken care of.

Examples

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let byte = Byte::from_str("123456789123456").unwrap();
let adjusted_byte = byte.get_adjusted_unit(ByteUnit::GB);

assert_eq!(123456.789123456, adjusted_byte.get_value());

let byte = adjusted_byte.get_byte();
let adjusted_byte = byte.get_adjusted_unit(ByteUnit::GB);

assert_eq!(123456.789123, adjusted_byte.get_value());

Trait Implementations

impl Clone for AdjustedByte

fn clone(&self) -> AdjustedByte

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for AdjustedByte

impl Debug for AdjustedByte

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

Formats the value using the given formatter.

impl Display for AdjustedByte

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

Formats the value using the given formatter.

impl Eq for AdjustedByte

impl From<AdjustedByte> for Byte

fn from(other: AdjustedByte) -> Byte

Performs the conversion.

impl Ord for AdjustedByte

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

Deal with the logical numeric comparation.

Examples

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let byte1 = Byte::from_unit(1024f64, ByteUnit::KiB).unwrap();
let byte2 = Byte::from_unit(1025f64, ByteUnit::KiB).unwrap();

assert!(byte1.get_appropriate_unit(false) < byte2.get_appropriate_unit(true));

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let byte1 = Byte::from_unit(1024f64, ByteUnit::KiB).unwrap();
let byte2 = Byte::from_unit(1.01f64, ByteUnit::MiB).unwrap();

assert!(byte1.get_appropriate_unit(true) < byte2.get_appropriate_unit(false));

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<AdjustedByte> for AdjustedByte

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

Deal with the logical numeric equivalent.

Examples

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let byte1 = Byte::from_unit(1024f64, ByteUnit::KiB).unwrap();
let byte2 = Byte::from_unit(1024f64, ByteUnit::KiB).unwrap();

assert_eq!(byte1.get_appropriate_unit(false), byte2.get_appropriate_unit(true));

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let byte1 = Byte::from_unit(1024f64, ByteUnit::KiB).unwrap();
let byte2 = Byte::from_unit(1f64, ByteUnit::MiB).unwrap();

assert_eq!(byte1.get_appropriate_unit(true), byte2.get_appropriate_unit(false));

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<AdjustedByte> for AdjustedByte

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

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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