Struct Size

#[repr(transparent)]
pub struct Size<'n>(Branded<'n, usize>);

usize value tied to the lifetime 'n.

Tuple Fields

0: Branded<'n, usize>

Implementations

impl<'size> Size<'size>

pub fn with<R>(n: usize, f: impl for<'n> FnOnce(Size<'n>) -> R) -> R

Create a new Size with a lifetime tied to n.

pub fn with2<R>( m: usize, n: usize, f: impl for<'m, 'n> FnOnce(Size<'m>, Size<'n>) -> R, ) -> R

Create two new Size with lifetimes tied to m and n.

pub unsafe fn new_raw_unchecked(n: usize) -> Size<'size>

Create a new Size tied to the lifetime 'n.

pub fn into_inner(self) -> usize

Returns the unconstrained value.

pub fn indices(self) -> impl DoubleEndedIterator

Returns an iterator of the indices smaller than self.

pub fn check<I>(self, idx: I) -> Idx<'size, I>

where I: Index,

Check that the index is bounded by self, or panic otherwise.

pub fn try_check<I>(self, idx: I) -> Option<Idx<'size, I>>

where I: Index,

Check that the index is bounded by self, or return None otherwise.

Methods from Deref<Target = usize>

pub const MIN: usize = 0usize

pub const MAX: usize = 18_446_744_073_709_551_615usize

pub const BITS: u32 = 64u32

Trait Implementations

impl<'n> Clone for Size<'n>

fn clone(&self) -> Size<'n>

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Deref for Size<'_>

type Target = usize

The resulting type after dereferencing.

fn deref(&self) -> &<Size<'_> as Deref>::Target

Dereferences the value.

impl<'n> Ord for Size<'n>

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

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

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

impl<'n> Eq for Size<'n>

impl<'n> StructuralPartialEq for Size<'n>