Struct BaseIndex32 

pub struct BaseIndex32 { /* private fields */ }

A specialized wrapper around a primitive number.

Implementations

impl BaseIndex32

pub const MAX_AS: u32 = 4_294_967_040u32

The maximum index value, as the underlying primitive type.

pub const MAX: Self

The maximum index value.

pub const fn new(value: u32) -> Self

Creates a new BaseIndex32 from the given value.

Panics

Panics if value exceeds MAX.

pub const fn try_new(value: u32) -> Option<Self>

Creates a new BaseIndex32 from the given value.

Returns None if value exceeds MAX.

pub const fn from_usize(value: usize) -> Self

Creates a new BaseIndex32 from the given value.

Panics

Panics if value exceeds MAX.

pub const fn try_from_usize(value: usize) -> Option<Self>

Creates a new BaseIndex32 from the given value.

Returns None if value exceeds MAX.

pub const unsafe fn new_unchecked(value: u32) -> Self

Creates a new BaseIndex32 from the given value, without checking for overflow.

Safety

The caller must ensure that value is less than or equal to MAX.

pub const unsafe fn from_usize_unchecked(value: usize) -> Self

Creates a new BaseIndex32 from the given value, without checking for overflow.

Safety

The caller must ensure that value is less than or equal to MAX.

pub const fn get(self) -> u32

Returns the underlying index value.

pub const fn index(self) -> usize

Returns the underlying index value.

Trait Implementations

impl Clone for BaseIndex32

fn clone(&self) -> BaseIndex32

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BaseIndex32

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

Formats the value using the given formatter.

impl Hash for BaseIndex32

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 Idx for BaseIndex32

fn from_usize(value: usize) -> Self

Construct an Index from a usize. This is equivalent to From<usize>.

fn index(self) -> usize

Get the underlying index. This is equivalent to Into<usize>

impl Ord for BaseIndex32

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

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

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

impl Eq for BaseIndex32

impl StructuralPartialEq for BaseIndex32

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 4 bytes