Struct FileSize 

pub struct FileSize { /* private fields */ }

File size value paired with a unit.

Implementations

impl FileSize

pub fn get_size(&self) -> u64

Returns the stored size value in the current unit.

pub fn get_unit(&self) -> FileSizeUnit

Returns the stored unit.

pub fn unit_as_string(&self) -> String

Returns a human-readable unit string, pluralized when needed.

Examples

use file_database::FileSize;

let size = FileSize::default();
assert_eq!(size.unit_as_string(), "Bytes");

pub fn as_unit(&self, unit: FileSizeUnit) -> Self

Returns a copy of this size converted to another unit.

Conversion uses powers of 1000 between adjacent units.

Parameters

• unit: destination unit.

Examples

use file_database::{FileSize, FileSizeUnit};

let bytes = FileSize::default().as_unit(FileSizeUnit::Byte);
assert_eq!(bytes.get_unit(), FileSizeUnit::Byte);

Trait Implementations

impl Clone for FileSize

fn clone(&self) -> FileSize

Returns a duplicate 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 Default for FileSize

fn default() -> FileSize

Returns the “default value” for a type.

impl PartialEq for FileSize

fn eq(&self, other: &FileSize) -> 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 FileSize

fn partial_cmp(&self, other: &FileSize) -> 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 Copy for FileSize

impl StructuralPartialEq for FileSize