Struct ReferenceId 

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

Implementations

impl ReferenceId

pub const MAX_INDEX: usize = 4_294_967_294usize

The maximum representable index value.

pub const CHECKS_MAX_INDEX: bool = true

Whether this index type performs bounds checking.

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

Create a new index from a usize value.

Panics

Panics if value > MAX_INDEX.

pub const fn from_raw(value: NonMaxU32) -> Self

Create an index from a raw NonMaxU32 value.

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

Convert an index from another index type.

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

Create an index from a usize without bounds checking.

Safety

The caller must ensure value <= MAX_INDEX.

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

Create an index from a raw u32 without bounds checking.

Safety

The caller must ensure the value is not u32::MAX.

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

Create an index from a usize with bounds checking.

Panics

Panics if value > MAX_INDEX.

pub const fn index(self) -> usize

Get the index value as a usize.

pub const fn raw(self) -> NonMaxU32

Get the raw NonMaxU32 value.

Trait Implementations

impl Add<ReferenceId> for usize

type Output = ReferenceId

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for ReferenceId

type Output = ReferenceId

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for ReferenceId

type Output = ReferenceId

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for ReferenceId

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl AddAssign for ReferenceId

fn add_assign(&mut self, other: ReferenceId)

Performs the += operation.

impl Clone for ReferenceId

fn clone(&self) -> ReferenceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'alloc> CloneIn<'alloc> for ReferenceId

type Cloned = ReferenceId

The type of the cloned object.

fn clone_in(&self, _: &'alloc Allocator) -> Self

Clone self into the given allocator. allocator may be the same one that self is already in.

fn clone_in_with_semantic_ids(&self, _: &'alloc Allocator) -> Self

Almost identical as clone_in, but for some special type, it will also clone the semantic ids. Please use this method only if you make sure semantic info is synced with the ast node.

impl Debug for ReferenceId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReferenceId

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<ReferenceId> for usize

fn from(v: ReferenceId) -> usize

Converts to this type from the input type.

impl From<usize> for ReferenceId

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for ReferenceId

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 ReferenceId

const MAX: usize = 4_294_967_294usize

The maximum value that can be represented by this index type.

unsafe fn from_usize_unchecked(idx: usize) -> Self

Construct an index from a usize without bounds checking.

fn index(self) -> usize

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

fn from_usize(idx: usize) -> Self

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

impl Ord for ReferenceId

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

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

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 ReferenceId

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

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

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 ReferenceId

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

type Output = ReferenceId

The resulting type after applying the % operator.

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

Performs the % operation.

impl Serialize for ReferenceId

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Sub<ReferenceId> for usize

type Output = ReferenceId

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for ReferenceId

type Output = ReferenceId

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for ReferenceId

type Output = ReferenceId

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for ReferenceId

fn sub_assign(&mut self, other: usize)

Performs the -= operation.

impl SubAssign for ReferenceId

fn sub_assign(&mut self, other: ReferenceId)

Performs the -= operation.

impl Copy for ReferenceId

impl Eq for ReferenceId

impl StructuralPartialEq for ReferenceId