Struct CounterUsize

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

An 64-bit counter, from 0 to usize::MAX elements.

Implementations

impl CounterUsize

constructors

pub const fn new() -> Self

Returns a new Counter at 0.

impl CounterUsize

methods

pub const fn as_primitive(&self) -> usize

Retuns the inner primitive type.

If the count pointed to nothing, the maximum primitive value will be returned.

pub const fn as_usize(&self) -> usize

Returns the inner primitive type as a usize.

If the count is invalid, the maximum primitive value casted to usize will be returned.

pub const fn as_current_index(&self) -> NonMaxIndexUsize

Returns a non-max index that points to 1 less than the current count.

If the current count is 0, the index will point to None.

pub const fn as_next_index(&self) -> NonMaxIndexUsize

Returns a non-max index that points to the current count value.

If the current count is usize::MAX, the index will point to None.

pub fn increment(&mut self) -> Result<()>

Increments the counter by 1.

Errors

Overflows if the counter would exceed usize::MAX.

pub fn increment_by(&mut self, increment: usize) -> Result<()>

Increments the counter by increment.

Errors

Overflows if the counter would exceed usize::MAX.

pub const fn incremented(&self) -> Result<Self>

Returns a copy of the counter incremented by 1.

Errors

Overflows if the counter would exceed usize::MAX.

pub const fn incremented_by(&self, increment: usize) -> Result<Self>

Returns a copy of the counter incremented by increment.

Errors

Overflows if the counter would exceed usize::MAX.

pub fn decrement(&mut self) -> Result<()>

Decrements the counter by 1.

Errors

Underflows if the counter would subceed 0.

pub fn decrement_by(&mut self, decrement: usize) -> Result<()>

Decrements the counter by decrement.

Errors

Underflows if the counter would subceed 0.

pub const fn decremented(&self) -> Result<Self>

Returns a copy of the counter decremented by 1.

Errors

Underflows if the counter would subceed 0. Underflow if the counter would subceed usize::MAX.

pub const fn decremented_by(&self, decrement: usize) -> Result<Self>

Returns a copy of the counter decremented by increment.

Errors

Underflows if the counter would subceed 0.

Trait Implementations

impl Clone for CounterUsize

fn clone(&self) -> CounterUsize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CounterUsize

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

Formats the value using the given formatter.

impl Default for CounterUsize

fn default() -> CounterUsize

Returns the “default value” for a type.

impl Display for CounterUsize

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

Formats the value using the given formatter.

impl Ord for CounterUsize

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

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

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

impl Eq for CounterUsize

impl StructuralPartialEq for CounterUsize