Enum SIUnit

pub enum SIUnit {
    Byte(f64, f64),
    Kilobyte(f64, f64),
    Megabyte(f64, f64),
    Gigabyte(f64, f64),
    Terabyte(f64, f64),
    Petabyte(f64, f64),
    Exabyte(f64, f64),
    Overflow,
}

Available on crate feature size_format only.

Represents different units of data size, allowing for conversion between human-readable representations and precise byte values.

This enum supports addition and subtraction operations. However, multiplication and division operations are only supported when working with f64 values.

Variants

Byte(f64, f64)

Kilobyte(f64, f64)

Megabyte(f64, f64)

Gigabyte(f64, f64)

Terabyte(f64, f64)

Petabyte(f64, f64)

Exabyte(f64, f64)

Overflow

Implementations

impl SIUnit

pub fn new(value: f64, unit_type: SISize) -> SIUnit

Creates a new instance of SIUnit based on the provided value and unit type.

This function is part of the SIUnit enum and supports units such as Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte, Exabyte, and Overflow. The conversion is based on the International System of Units (SI) standard for decimal prefixes.

Arguments

• value - A positive f64 representing the numeric value of the size.
• unit_type - An SISize enum specifying the unit type.

Returns

• An SIUnit enum representing the converted size.

Example

use get_chunk::data_size_format::si::{SISize, SIUnit};
use get_chunk::iterator::FileIter;
use get_chunk::ChunkSize;

fn main() -> std::io::Result<()> {
    // Set the fixed chunk size to 250 megabytes
    let file_iter = FileIter::new("file.bin")?.set_mode(ChunkSize::Bytes(
        SIUnit::new(250.0, SISize::Megabyte).into(),
    ));

    for chunk in file_iter {
        match chunk {
            Ok(data) => {
                // Some calculations with chunk
                // .....
            }
            Err(_) => break,
        }
    }
    Ok(())
}

pub fn auto(bytes: f64) -> SIUnit

Converts a byte size into the appropriate International System of Units (SI) unit.

This function is part of the SIUnit enum and supports units such as Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte, Exabyte, and Overflow. The conversion is based on the SI standard for decimal prefixes.

Arguments

• bytes - A positive f64 representing the size in bytes.

Returns

• An SIUnit enum representing the converted size.

Example

use get_chunk::data_size_format::si::SIUnit;
use get_chunk::iterator::FileIter;

fn main() -> std::io::Result<()> {
    let file_iter = FileIter::new("file.bin")?;

    // Display format
    println!("{}", SIUnit::auto(file_iter.get_file_size()));
    // Output: 54.08 GB

    // Debug format ( `debug` attribute is required )
    println!("{:?}", SIUnit::auto(file_iter.get_file_size()));
    // Output: Gigabyte(54.081281708, 54081281708.0)

    Ok(())
}

pub fn get_values(&self) -> (f64, f64)

Retrieves the numeric values associated with an instance of the SIUnit enum.

Returns

A tuple (value_h, value_b) representing the high-level numeric value and its equivalent in bytes.

Trait Implementations

impl Add for SIUnit

type Output = SIUnit

The resulting type after applying the + operator.

fn add(self, other: SIUnit) -> SIUnit

Performs the + operation.

impl Clone for SIUnit

fn clone(&self) -> SIUnit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SIUnit

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

Formats the value using the given formatter.

impl Default for SIUnit

fn default() -> Self

Returns the “default value” for a type.

impl Display for SIUnit

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

Formats the value using the given formatter.

impl Div<f64> for SIUnit

type Output = SIUnit

The resulting type after applying the / operator.

fn div(self, divisor: f64) -> SIUnit

Performs the / operation.

impl From<IECUnit> for SIUnit

fn from(iec_unit: IECUnit) -> Self

Converts to this type from the input type.

impl From<SIUnit> for IECUnit

fn from(si_unit: SIUnit) -> Self

Converts to this type from the input type.

impl From<SIUnit> for f64

fn from(data_size_unit: SIUnit) -> Self

Converts to this type from the input type.

impl From<SIUnit> for usize

Converts an SIUnit to a usize value.

fn from(data_size_unit: SIUnit) -> Self

Warning: This conversion may result in data loss.

impl IntoEnumIterator for SIUnit

type Iterator = SIUnitIter

fn iter() -> SIUnitIter

impl Mul<f64> for SIUnit

type Output = SIUnit

The resulting type after applying the * operator.

fn mul(self, scalar: f64) -> SIUnit

Performs the * operation.

impl PartialEq for SIUnit

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SIUnit

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub for SIUnit

type Output = SIUnit

The resulting type after applying the - operator.

fn sub(self, other: SIUnit) -> SIUnit

Performs the - operation.

impl Copy for SIUnit

impl StructuralPartialEq for SIUnit