Struct index_vec::example_generated::CoolIndex

#[repr(transparent)]
pub struct CoolIndex { /* fields omitted */ }

I'm a doc comment on the type.

Methods

impl CoolIndex

pub const MAX_INDEX: usize

If Self::CHECKS_MAX_INDEX is true, we'll assert if trying to produce a value larger than this in any of the ctors that don't have unchecked in their name.

pub const CHECKS_MAX_INDEX: bool

Does this index type assert if asked to construct an index larger than MAX_INDEX?

pub fn new(value: usize) -> Self

Construct this index type from a usize. Alias for from_usize.

pub fn from_raw(value: u32) -> Self

Construct this index type from the wrapped integer type.

pub fn from_foreign<F: Idx>(value: F) -> Self

Construct this index type from one in a different domain

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

Construct from a usize without any checks.

pub const fn from_raw_unchecked(raw: u32) -> Self

Construct from the underlying type without any checks.

pub fn from_usize(value: usize) -> Self

Construct this index type from a usize.

pub fn index(self) -> usize

Get the wrapped index as a usize.

pub fn raw(self) -> u32

Get the wrapped index.

pub fn check_index(v: usize)

Asserts v <= Self::MAX_INDEX unless Self::CHECKS_MAX_INDEX is false.

Trait Implementations

impl Idx for CoolIndex

fn from_usize(value: usize) -> Self

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

fn index(self) -> usize

Get the underlying index. This is equivalent to Into

impl From<CoolIndex> for usize

fn from(v: CoolIndex) -> usize

Performs the conversion.

impl From<usize> for CoolIndex

fn from(value: usize) -> Self

Performs the conversion.

impl From<CoolIndex> for u32

fn from(v: CoolIndex) -> u32

Performs the conversion.

impl From<u32> for CoolIndex

fn from(value: u32) -> Self

Performs the conversion.

impl PartialEq<CoolIndex> for CoolIndex

fn eq(&self, other: &CoolIndex) -> bool

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

fn ne(&self, other: &CoolIndex) -> bool

This method tests for !=.

impl PartialEq<usize> for CoolIndex

fn eq(&self, other: &usize) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<CoolIndex> for usize

fn eq(&self, other: &CoolIndex) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for CoolIndex

impl Ord for CoolIndex

fn cmp(&self, other: &CoolIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<CoolIndex> for CoolIndex

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

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

fn lt(&self, other: &CoolIndex) -> bool

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

fn le(&self, other: &CoolIndex) -> bool

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

fn gt(&self, other: &CoolIndex) -> bool

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

fn ge(&self, other: &CoolIndex) -> bool

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

impl PartialOrd<usize> for CoolIndex

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl PartialOrd<CoolIndex> for usize

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl Hash for CoolIndex

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, 

Feeds a slice of this type into the given [Hasher].

impl Add<usize> for CoolIndex

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: usize) -> Self

Performs the + operation.

impl Add<CoolIndex> for usize

type Output = CoolIndex

The resulting type after applying the + operator.

fn add(self, other: CoolIndex) -> CoolIndex

Performs the + operation.

impl Add<CoolIndex> for CoolIndex

type Output = CoolIndex

The resulting type after applying the + operator.

fn add(self, other: CoolIndex) -> CoolIndex

Performs the + operation.

impl Sub<usize> for CoolIndex

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: usize) -> Self

Performs the - operation.

impl Sub<CoolIndex> for usize

type Output = CoolIndex

The resulting type after applying the - operator.

fn sub(self, other: CoolIndex) -> CoolIndex

Performs the - operation.

impl Sub<CoolIndex> for CoolIndex

type Output = CoolIndex

The resulting type after applying the - operator.

fn sub(self, other: CoolIndex) -> CoolIndex

Performs the - operation.

impl Rem<usize> for CoolIndex

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: usize) -> Self

Performs the % operation.

impl AddAssign<usize> for CoolIndex

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl AddAssign<CoolIndex> for CoolIndex

fn add_assign(&mut self, other: CoolIndex)

Performs the += operation.

impl SubAssign<usize> for CoolIndex

fn sub_assign(&mut self, other: usize)

Performs the -= operation.

impl SubAssign<CoolIndex> for CoolIndex

fn sub_assign(&mut self, other: CoolIndex)

Performs the -= operation.

impl Debug for CoolIndex

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

Formats the value using the given formatter.

impl Display for CoolIndex

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

Formats the value using the given formatter.

impl Copy for CoolIndex

impl Clone for CoolIndex

fn clone(&self) -> CoolIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CoolIndex

fn default() -> Self

Returns the "default value" for a type.