Struct Filesize

pub struct Filesize(/* private fields */);

A signed number of bytes.

Filesize is a wrapper around i64. Whereas i64 is a dimensionless value, Filesize represents a numerical value with a dimensional unit (byte).

A Filesize can be created from an i64 using Filesize::new or the From or Into trait implementations. To get the underlying i64 value, use Filesize::get or the From or Into trait implementations.

Implementations

impl Filesize

pub const ZERO: Self

A Filesize of 0 bytes.

pub const MIN: Self

The smallest possible Filesize value.

pub const MAX: Self

The largest possible Filesize value.

pub const fn new(bytes: i64) -> Self

Create a new Filesize from a i64 number of bytes.

pub const fn from_unit(value: i64, unit: FilesizeUnit) -> Option<Self>

Creates a Filesize from a signed multiple of a FilesizeUnit.

If the resulting number of bytes calculated by value * unit.as_bytes() overflows an i64, then None is returned.

pub const fn get(&self) -> i64

Returns the underlying i64 number of bytes in a Filesize.

pub const fn is_positive(self) -> bool

Returns true if a Filesize is positive and false if it is zero or negative.

pub const fn is_negative(self) -> bool

Returns true if a Filesize is negative and false if it is zero or positive.

pub const fn signum(self) -> Self

Returns a Filesize representing the sign of self.

• 0 if the file size is zero
• 1 if the file size is positive
• -1 if the file size is negative

pub const fn largest_metric_unit(&self) -> FilesizeUnit

Returns the largest FilesizeUnit with a metric prefix that is smaller than or equal to self.

Examples

let filesize = Filesize::from(FilesizeUnit::KB);
assert_eq!(filesize.largest_metric_unit(), FilesizeUnit::KB);

let filesize = Filesize::new(FilesizeUnit::KB.as_bytes() as i64 - 1);
assert_eq!(filesize.largest_metric_unit(), FilesizeUnit::B);

let filesize = Filesize::from(FilesizeUnit::KiB);
assert_eq!(filesize.largest_metric_unit(), FilesizeUnit::KB);

pub const fn largest_binary_unit(&self) -> FilesizeUnit

Returns the largest FilesizeUnit with a binary prefix that is smaller than or equal to self.

Examples

let filesize = Filesize::from(FilesizeUnit::KiB);
assert_eq!(filesize.largest_binary_unit(), FilesizeUnit::KiB);

let filesize = Filesize::new(FilesizeUnit::KiB.as_bytes() as i64 - 1);
assert_eq!(filesize.largest_binary_unit(), FilesizeUnit::B);

let filesize = Filesize::from(FilesizeUnit::MB);
assert_eq!(filesize.largest_binary_unit(), FilesizeUnit::KiB);

pub fn display(&self, unit: FilesizeUnit) -> DisplayFilesize

Returns a struct that can be used to display a Filesize scaled to the given FilesizeUnit.

You can use largest_binary_unit or largest_metric_unit to automatically determine a FilesizeUnit of appropriate scale for a specific Filesize.

The default Display implementation for Filesize is self.display(self.largest_metric_unit()).

Examples

let filesize = Filesize::from_unit(4, FilesizeUnit::KiB).unwrap();

assert_eq!(filesize.display(FilesizeUnit::B).to_string(), "4096 B");
assert_eq!(filesize.display(FilesizeUnit::KiB).to_string(), "4 KiB");
assert_eq!(filesize.display(filesize.largest_binary_unit()).to_string(), "4 KiB");
assert_eq!(filesize.display(filesize.largest_metric_unit()).to_string(), "4.096 kB");

Trait Implementations

impl Add for Filesize

type Output = Option<Filesize>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

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<'de> Deserialize<'de> for Filesize

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Filesize

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

Formats the value using the given formatter.

impl From<Filesize> for i64

fn from(filesize: Filesize) -> Self

Converts to this type from the input type.

impl From<FilesizeUnit> for Filesize

fn from(unit: FilesizeUnit) -> Self

Converts to this type from the input type.

impl From<i16> for Filesize

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Filesize

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Filesize

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Filesize

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for Filesize

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Filesize

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u8> for Filesize

fn from(value: u8) -> Self

Converts to this type from the input type.

impl FromValue for Filesize

fn from_value(value: Value) -> Result<Self, ShellError>

Loads a value from a Value.

fn expected_type() -> Type

Expected Value type.

impl Hash for Filesize

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for Filesize

fn into_value(self, span: Span) -> Value

Converts the given value to a Value.

impl Mul<Filesize> for f64

type Output = Option<Filesize>

The resulting type after applying the * operator.

fn mul(self, rhs: Filesize) -> Self::Output

Performs the * operation.

impl Mul<Filesize> for i64

type Output = Option<Filesize>

The resulting type after applying the * operator.

fn mul(self, rhs: Filesize) -> Self::Output

Performs the * operation.

impl Mul<f64> for Filesize

type Output = Option<Filesize>

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Mul<i64> for Filesize

type Output = Option<Filesize>

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> Self::Output

Performs the * operation.

impl Neg for Filesize

type Output = Option<Filesize>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Filesize

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 Serialize for Filesize

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Filesize

type Output = Option<Filesize>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Sum<Filesize> for Option<Filesize>

fn sum<I: Iterator<Item = Filesize>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<Filesize> for i16

type Error = <i64 as TryInto<i16>>::Error

The type returned in the event of a conversion error.

fn try_from(filesize: Filesize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Filesize> for i32

type Error = <i64 as TryInto<i32>>::Error

The type returned in the event of a conversion error.

fn try_from(filesize: Filesize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Filesize> for i8

type Error = <i64 as TryInto<i8>>::Error

The type returned in the event of a conversion error.

fn try_from(filesize: Filesize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Filesize> for isize

type Error = <i64 as TryInto<isize>>::Error

The type returned in the event of a conversion error.

fn try_from(filesize: Filesize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Filesize> for u16

type Error = <i64 as TryInto<u16>>::Error

The type returned in the event of a conversion error.

fn try_from(filesize: Filesize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Filesize> for u32

type Error = <i64 as TryInto<u32>>::Error

The type returned in the event of a conversion error.

fn try_from(filesize: Filesize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Filesize> for u64

type Error = <i64 as TryInto<u64>>::Error

The type returned in the event of a conversion error.

fn try_from(filesize: Filesize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Filesize> for u8

type Error = <i64 as TryInto<u8>>::Error

The type returned in the event of a conversion error.

fn try_from(filesize: Filesize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Filesize> for usize

type Error = <i64 as TryInto<usize>>::Error

The type returned in the event of a conversion error.

fn try_from(filesize: Filesize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f32> for Filesize

type Error = TryFromFloatError

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for Filesize

type Error = TryFromFloatError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for Filesize

type Error = <isize as TryInto<i64>>::Error

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Filesize

type Error = <u64 as TryInto<i64>>::Error

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Filesize

type Error = <usize as TryInto<i64>>::Error

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Filesize

impl Eq for Filesize

impl StructuralPartialEq for Filesize