Struct PlaceIndex

pub struct PlaceIndex {
    private_use_as_methods_instead: u32,
}

This index uniquely identifies a place.

Not every place has a PlaceIndex, and not every PlaceIndex corresponds to a tracked place. However, every tracked place and all places along its projection have a PlaceIndex.

Fields

private_use_as_methods_instead: u32

Implementations

impl PlaceIndex

pub const MAX_AS_U32: u32 = 4_294_967_040u32

Maximum value the index can take, as a u32.

pub const MAX: Self = _

Maximum value the index can take.

pub const ZERO: Self = _

Zero value of the index.

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

Creates a new index from a given usize.

Panics

Will panic if value exceeds MAX.

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

Creates a new index from a given u32.

Panics

Will panic if value exceeds MAX.

pub const fn from_u16(value: u16) -> Self

Creates a new index from a given u16.

Panics

Will panic if value exceeds MAX.

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

Creates a new index from a given u32.

Safety

The provided value must be less than or equal to the maximum value for the newtype. Providing a value outside this range is undefined due to layout restrictions.

Prefer using from_u32.

pub const fn index(self) -> usize

Extracts the value of this index as a usize.

pub const fn as_u32(self) -> u32

Extracts the value of this index as a u32.

pub const fn as_usize(self) -> usize

Extracts the value of this index as a usize.

Trait Implementations

impl Add<usize> for PlaceIndex

type Output = PlaceIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for PlaceIndex

fn clone(&self) -> PlaceIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlaceIndex

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

Formats the value using the given formatter.

impl From<PlaceIndex> for u32

fn from(v: PlaceIndex) -> u32

Converts to this type from the input type.

impl From<PlaceIndex> for usize

fn from(v: PlaceIndex) -> usize

Converts to this type from the input type.

impl From<u32> for PlaceIndex

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<usize> for PlaceIndex

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for PlaceIndex

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 PlaceIndex

fn new(value: usize) -> Self

fn index(self) -> usize

fn increment_by(&mut self, amount: usize)

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

impl PartialEq for PlaceIndex

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

impl Eq for PlaceIndex

impl StructuralPartialEq for PlaceIndex

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