Struct byte_unit::Byte

pub struct Byte { /* fields omitted */ }

Represent the n-bytes data. Use associated functions: from_unit, from_bytes, from_str, to create the instance.

Methods

impl Byte

pub fn from_unit(value: f64, unit: ByteUnit) -> Result<Byte, ByteError>

Create a new Byte object from a specified value and a unit. Accuracy should be taken care of.

Examples

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_unit(1500f64, ByteUnit::KB).unwrap();

assert_eq!(result.get_bytes(), 1500000u128);

pub fn from_bytes(bytes: u128) -> Byte

Create a new Byte object from bytes.

Examples

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_bytes(1500000u128);

assert_eq!(result.get_bytes(), 1500000u128);

pub fn from_str<S: AsRef<str>>(s: S) -> Result<Byte, ByteError>

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

Examples

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_str("123KiB").unwrap();

assert_eq!(result, Byte::from_unit(123f64, ByteUnit::KiB).unwrap());

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_str("50.84 MB").unwrap();

assert_eq!(result, Byte::from_unit(50.84f64, ByteUnit::MB).unwrap());

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_str("8 B").unwrap(); // 8 bytes

assert_eq!(result.get_bytes(), 8u128);

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_str("8").unwrap(); // 8 bytes

assert_eq!(result.get_bytes(), 8u128);

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_str("8 b").unwrap(); // 8 bytes

assert_eq!(result.get_bytes(), 8u128);

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_str("8 kb").unwrap(); // 8K bytes

assert_eq!(result.get_bytes(), 8000u128);

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_str("8 kib").unwrap(); // 8Ki bytes

assert_eq!(result.get_bytes(), 8192u128);

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let result = Byte::from_str("8 k").unwrap(); // 8K bytes

assert_eq!(result.get_bytes(), 8000u128);

pub fn get_bytes(&self) -> u128

Get bytes represented by a Byte object.

Examples

extern crate byte_unit;

use byte_unit::Byte;

let byte = Byte::from_str("123KiB").unwrap();

let result = byte.get_bytes();

assert_eq!(result, 125952);

extern crate byte_unit;

use byte_unit::Byte;

let byte = Byte::from_str("50.84 MB").unwrap();

let result = byte.get_bytes();

assert_eq!(result, 50840000);

pub fn get_appropriate_unit(&self, binary_multiples: bool) -> AdjustedByte

Find the appropriate unit and value for Byte object. Accuracy should be taken care of.

Examples

extern crate byte_unit;

use byte_unit::Byte;

let byte = Byte::from_str("123KiB").unwrap();

let adjusted_byte = byte.get_appropriate_unit(false);

assert_eq!(adjusted_byte.to_string(), "125.95 KB");

extern crate byte_unit;

use byte_unit::Byte;

let byte = Byte::from_str("50.84 MB").unwrap();

let adjusted_byte = byte.get_appropriate_unit(true);

assert_eq!(adjusted_byte.to_string(), "48.48 MiB");

pub fn get_adjusted_unit(&self, unit: ByteUnit) -> AdjustedByte

Adjust the unit and value for Byte object. Accuracy should be taken care of.

Examples

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let byte = Byte::from_str("123KiB").unwrap();

let adjusted_byte = byte.get_adjusted_unit(ByteUnit::KB);

assert_eq!(adjusted_byte.to_string(), "125.95 KB");

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

let byte = Byte::from_str("50.84 MB").unwrap();

let adjusted_byte = byte.get_adjusted_unit(ByteUnit::MiB);

assert_eq!(adjusted_byte.to_string(), "48.48 MiB");

Trait Implementations

impl PartialEq<Byte> for Byte

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

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

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

This method tests for !=.

impl Eq for Byte

impl Ord for Byte

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<Byte> for Byte

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

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

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

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

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

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

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

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

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

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

impl Debug for Byte

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

Formats the value using the given formatter.

impl Display for Byte

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

Formats the value using the given formatter.

impl FromStr for Byte

type Err = ByteError

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 Copy for Byte

impl Clone for Byte

fn clone(&self) -> Byte

Returns a copy of the value.

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

Performs copy-assignment from source.