Struct byte_unit::Byte[−][src]

pub struct Byte(_);

Expand description

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

Implementations

[src]

impl Byte

[src]

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!(1500000, result.get_bytes());

[src]

pub const 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(1500000);

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

[src]

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!(Byte::from_unit(123f64, ByteUnit::KiB).unwrap(), result);

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

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

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

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

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

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

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

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

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

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

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

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

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

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

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

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

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

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

extern crate byte_unit;

use byte_unit::{Byte, ByteUnit};

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

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

[src]

impl Byte

[src]

pub const 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!(125952, result);

extern crate byte_unit;

use byte_unit::Byte;

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

let result = byte.get_bytes();

assert_eq!(50840000, result);

[src]

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!("125.95 KB", adjusted_byte.to_string());

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!("48.48 MiB", adjusted_byte.to_string());

[src]

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!("125.95 KB", adjusted_byte.to_string());

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!("48.48 MiB", adjusted_byte.to_string());