Struct zeus_fm::zeuslib::utils::fs::filesize::FileSize

pub struct FileSize {
    pub pb: u16,
    pub tb: u16,
    pub gb: u16,
    pub mb: u16,
    pub kb: u16,
    pub b: u16,
}

The size of a file, consisting of counts for data units.

Fields

pb: u16

Pebibytes (2⁵⁰ bytes) component of the file size

tb: u16

Tebibytes (2⁴⁰ bytes) component of the file size

gb: u16

Gibibytes (2³⁰ bytes) component of the file size

mb: u16

Mebibytes (2²⁰ bytes) component of the file size

kb: u16

Kibibytes (2¹⁰ bytes) component of the file size

b: u16

Bytes component of the file size

Implementations

impl FileSize

pub fn from_total_bytes(total_bytes: u64) -> Self

Returns a new FileSize with representing given number of bytes

This produces a FileSize with optimal values for each count field. In other words, the largest possible units are filled first, rather than just setting the bytes field to the input.

Arguments

• total_bytes - The number of bytes the new FileSize should represent

Examples

use zeus_fm::zeuslib::utils::fs::FileSize;

const b: u64 = 1048726;

let fs = FileSize::from_total_bytes(b);

assert_eq!(fs.pb, 0);
assert_eq!(fs.tb, 0);
assert_eq!(fs.gb, 0);
assert_eq!(fs.mb, 1);
assert_eq!(fs.kb, 0);
assert_eq!(fs.b, 150);

pub fn get_total_bytes(&self) -> u64

Get the total number of bytes in this FileSize

Examples

use zeus_fm::zeuslib::utils::fs::FileSize;

const b: u64 = 1048576;
let fsize = FileSize::from_total_bytes(b); // Create a `FileSize`
let total_bytes = fsize.get_total_bytes(); // Get the total number of bytes

assert_eq!(total_bytes, b);

pub fn get_fractional_pb(&self) -> f64

Get the total number of Pebibytes (2⁵⁰ bytes) this FileSize represents as a floating-point number.

pub fn get_fractional_tb(&self) -> f64

Get the total number of Tebibytes (2⁴⁰ bytes) this FileSize represents as a floating-point number.

pub fn get_fractional_gb(&self) -> f64

Get the total number of Gibibytes (2³⁰ bytes) this FileSize represents as a floating-point number.

pub fn get_fractional_mb(&self) -> f64

Get the total number of Mebibytes (2²⁰ bytes) this FileSize represents as a floating-point number.

pub fn get_fractional_kb(&self) -> f64

Get the total number of Kibibytes (2¹⁰ bytes) this FileSize represents as a floating-point number.

Trait Implementations

impl Clone for FileSize

fn clone(&self) -> FileSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileSize

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

Formats the value using the given formatter.

impl Display for FileSize

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

Formats the value using the given formatter.

impl Eq for FileSize

impl Ord for FileSize

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<FileSize> for FileSize

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

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

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

This method tests for !=.

impl PartialOrd<FileSize> for FileSize

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

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

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

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

#[must_use]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]fn gt(&self, other: &Rhs) -> bool

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

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

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