Struct LocationOrArgIndex

pub struct LocationOrArgIndex { /* private fields */ }

Available on crate feature indexical only.

Implementations

impl LocationOrArgIndex

pub const MAX_INDEX: usize = 4_294_967_295usize

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 = true

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 const fn index(self) -> usize

Get the wrapped index as a usize.

pub const 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 Add<LocationOrArgIndex> for usize

type Output = LocationOrArgIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for LocationOrArgIndex

type Output = LocationOrArgIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for LocationOrArgIndex

type Output = LocationOrArgIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for LocationOrArgIndex

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl AddAssign for LocationOrArgIndex

fn add_assign(&mut self, other: LocationOrArgIndex)

Performs the += operation.

impl Clone for LocationOrArgIndex

fn clone(&self) -> LocationOrArgIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocationOrArgIndex

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

Formats the value using the given formatter.

impl From<LocationOrArgIndex> for usize

fn from(v: LocationOrArgIndex) -> usize

Converts to this type from the input type.

impl From<usize> for LocationOrArgIndex

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for LocationOrArgIndex

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 LocationOrArgIndex

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

fn new(idx: usize) -> Self

fn index(self) -> usize

fn increment_by(&mut self, amount: usize)

fn plus(self, amount: usize) -> Self

impl Ord for LocationOrArgIndex

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

fn eq(&self, other: &LocationOrArgIndex) -> 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 PartialEq<usize> for LocationOrArgIndex

fn eq(&self, other: &usize) -> 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 PartialEq for LocationOrArgIndex

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

fn partial_cmp(&self, other: &LocationOrArgIndex) -> 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 PartialOrd<usize> for LocationOrArgIndex

fn partial_cmp(&self, other: &usize) -> 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 PartialOrd for LocationOrArgIndex

fn partial_cmp(&self, other: &LocationOrArgIndex) -> 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 Rem<usize> for LocationOrArgIndex

type Output = LocationOrArgIndex

The resulting type after applying the % operator.

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

Performs the % operation.

impl Sub<LocationOrArgIndex> for usize

type Output = LocationOrArgIndex

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for LocationOrArgIndex

type Output = LocationOrArgIndex

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for LocationOrArgIndex

type Output = LocationOrArgIndex

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for LocationOrArgIndex

fn sub_assign(&mut self, other: usize)

Performs the -= operation.

impl SubAssign for LocationOrArgIndex

fn sub_assign(&mut self, other: LocationOrArgIndex)

Performs the -= operation.

impl Copy for LocationOrArgIndex

impl Eq for LocationOrArgIndex

impl StructuralPartialEq for LocationOrArgIndex