Struct Size

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

Type-safe wrapper for size values in file system operations.

Size represents sizes, lengths, and byte counts as a 64-bit unsigned integer. This provides a range of 0 to approximately 18 exabytes, which is sufficient for any practical file system operation. The type provides various conversion methods and arithmetic operations for convenient size manipulation.

Examples

use file_system::Size;

// Create a size representing 1024 bytes
let size = Size::new(1024);
assert_eq!(size.As_u64(), 1024);

// Convert from usize
let size_from_usize: Size = 512usize.into();
assert_eq!(size_from_usize.As_u64(), 512);

// Arithmetic operations
let total = size + size_from_usize;
assert_eq!(total.As_u64(), 1536);

Type Safety

Using Size instead of raw integers helps prevent mixing up different numeric types and provides clearer API signatures throughout the file system.

Implementations

impl Size

pub const fn new(item: u64) -> Self

Create a new size value from a u64.

Arguments

• Item - The size value in bytes

Examples

use file_system::Size;

let size = Size::new(2048);
assert_eq!(size.As_u64(), 2048);

pub const fn as_u64(&self) -> u64

Get the size value as a u64.

Returns

The size value in bytes as a 64-bit unsigned integer.

Examples

use file_system::Size;

let size = Size::new(4096);
assert_eq!(size.As_u64(), 4096);

Trait Implementations

impl Add<Size> for u64

type Output = Size

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Size> for usize

type Output = Size

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u64> for Size

type Output = Size

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for Size

type Output = Size

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Size

type Output = Size

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Size> for usize

fn add_assign(&mut self, rhs: Size)

Performs the += operation.

impl AddAssign<u64> for Size

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl AddAssign<usize> for Size

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl AddAssign for Size

fn add_assign(&mut self, rhs: Size)

Performs the += operation.

impl Clone for Size

fn clone(&self) -> Size

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Size

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

Formats the value using the given formatter.

impl Default for Size

fn default() -> Size

Returns the “default value” for a type.

impl Display for Size

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

Formats the value using the given formatter.

impl From<Size> for u64

fn from(item: Size) -> Self

Converts to this type from the input type.

impl From<Size> for usize

fn from(item: Size) -> Self

Converts to this type from the input type.

impl From<u64> for Size

fn from(item: u64) -> Self

Converts to this type from the input type.

impl From<usize> for Size

fn from(item: usize) -> Self

Converts to this type from the input type.

impl Ord for Size

fn cmp(&self, other: &Size) -> 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<usize> for Size

fn eq(&self, other: &usize) -> 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 PartialEq for Size

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

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

impl Eq for Size

impl StructuralPartialEq for Size