Struct byte_unit::Byte [−][src]
pub struct Byte(_);
Represent the n-bytes data. Use associated functions: from_unit
, from_bytes
, from_str
, to create the instance.
Implementations
impl Byte
[src]
impl Byte
[src]pub fn from_unit(value: f64, unit: ByteUnit) -> Result<Byte, ByteError>
[src]
pub fn from_unit(value: f64, unit: ByteUnit) -> Result<Byte, ByteError>
[src]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());
pub const fn from_bytes(bytes: u128) -> Byte
[src]
pub const fn from_bytes(bytes: u128) -> Byte
[src]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());
pub fn from_str<S: AsRef<str>>(s: S) -> Result<Byte, ByteError>
[src]
pub fn from_str<S: AsRef<str>>(s: S) -> Result<Byte, ByteError>
[src]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());
impl Byte
[src]
impl Byte
[src]pub const fn get_bytes(&self) -> u128
[src]
pub const fn get_bytes(&self) -> u128
[src]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);
pub fn get_adjusted_unit(&self, unit: ByteUnit) -> AdjustedByte
[src]
pub fn get_adjusted_unit(&self, unit: ByteUnit) -> AdjustedByte
[src]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());
pub fn get_appropriate_unit(&self, binary_multiples: bool) -> AdjustedByte
[src]
pub fn get_appropriate_unit(&self, binary_multiples: bool) -> AdjustedByte
[src]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());
Trait Implementations
impl From<AdjustedByte> for Byte
[src]
impl From<AdjustedByte> for Byte
[src]fn from(other: AdjustedByte) -> Byte
[src]
fn from(other: AdjustedByte) -> Byte
[src]Performs the conversion.
impl Ord for Byte
[src]
impl Ord for Byte
[src]impl PartialOrd<Byte> for Byte
[src]
impl PartialOrd<Byte> for Byte
[src]fn partial_cmp(&self, other: &Byte) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Byte) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for Byte
[src]
impl Eq for Byte
[src]
impl StructuralEq for Byte
[src]
impl StructuralPartialEq for Byte
[src]
Auto Trait Implementations
impl RefUnwindSafe for Byte
impl Send for Byte
impl Sync for Byte
impl Unpin for Byte
impl UnwindSafe for Byte
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more