Struct os_units::Size

#[repr(transparent)]pub struct Size<T: Unit> { /* fields omitted */ }

A struct containing the value with the unit specified by generic type.

Implementations

impl<T: Unit> Size<T>

pub fn new(val: usize) -> Self

Creates a new instance with given value.

pub fn as_usize(self) -> usize

Returns the value.

impl Size<Bytes>

pub fn as_num_of_pages<T: PageSize>(self) -> Size<NumOfPages<T>>

Converts bytes to the number of physical pages. Note that the number of physical pages will be calculated so that the specified bytes will be fit in pages.

impl<T: PageSize> Size<NumOfPages<T>>

pub fn as_bytes(self) -> Size<Bytes>

Convert the number of physical pages to bytes.

Trait Implementations

impl Add<Size<Bytes>> for Size<Bytes>

type Output = Size<Bytes>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: PageSize> Add<Size<NumOfPages<T>>> for Size<NumOfPages<T>>

type Output = Size<NumOfPages<T>>

The resulting type after applying the + operator.

fn add(self, rhs: Size<NumOfPages<T>>) -> Self

Performs the + operation.

impl AddAssign<Size<Bytes>> for Size<Bytes>

fn add_assign(&mut self, rhs: Size<Bytes>)

Performs the += operation.

impl<T: PageSize> AddAssign<Size<NumOfPages<T>>> for Size<NumOfPages<T>>

fn add_assign(&mut self, rhs: Size<NumOfPages<T>>)

Performs the += operation.

impl<T: Clone + Unit> Clone for Size<T>

fn clone(&self) -> Size<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Unit> Copy for Size<T>

impl<T: Debug + Unit> Debug for Size<T>

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

Formats the value using the given formatter.

impl<T: Eq + Unit> Eq for Size<T>

impl<T: Ord + Unit> Ord for Size<T>

fn cmp(&self, other: &Size<T>) -> 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<T: PartialEq + Unit> PartialEq<Size<T>> for Size<T>

fn eq(&self, other: &Size<T>) -> bool

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

fn ne(&self, other: &Size<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + Unit> PartialOrd<Size<T>> for Size<T>

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

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

fn lt(&self, other: &Size<T>) -> bool

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

fn le(&self, other: &Size<T>) -> bool

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

fn gt(&self, other: &Size<T>) -> bool

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

fn ge(&self, other: &Size<T>) -> bool

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

impl<T: Unit> StructuralEq for Size<T>

impl<T: Unit> StructuralPartialEq for Size<T>

impl Sub<Size<Bytes>> for Size<Bytes>

type Output = Size<Bytes>

The resulting type after applying the - operator.

fn sub(self, rhs: Size<Bytes>) -> Self

Performs the - operation.

impl<T: PageSize> Sub<Size<NumOfPages<T>>> for Size<NumOfPages<T>>

type Output = Size<NumOfPages<T>>

The resulting type after applying the - operator.

fn sub(self, rhs: Size<NumOfPages<T>>) -> Self

Performs the - operation.

impl SubAssign<Size<Bytes>> for Size<Bytes>

fn sub_assign(&mut self, rhs: Size<Bytes>)

Performs the -= operation.

impl<T: PageSize> SubAssign<Size<NumOfPages<T>>> for Size<NumOfPages<T>>

fn sub_assign(&mut self, rhs: Size<NumOfPages<T>>)

Performs the -= operation.