Struct SymbolId 

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

Implementations

impl SymbolId

pub const MAX_INDEX: usize

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) -> SymbolId

Create a new index from a usize value.

Panics

Panics if value > MAX_INDEX.

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

Create an index from a raw NonMaxU32 value.

pub fn from_foreign<F>(value: F) -> SymbolId

where F: Idx,

Convert an index from another index type.

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

Create an index from a usize without bounds checking.

SAFETY

The caller must ensure value < (u32::MAX as usize).

pub const unsafe fn from_raw_unchecked(raw: u32) -> SymbolId

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) -> SymbolId

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 for SymbolId

type Output = SymbolId

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<usize> for SymbolId

type Output = SymbolId

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for SymbolId

fn add_assign(&mut self, other: SymbolId)

Performs the += operation.

impl AddAssign<usize> for SymbolId

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl Clone for SymbolId

fn clone(&self) -> SymbolId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'alloc> CloneIn<'alloc> for SymbolId

type Cloned = SymbolId

The type of the cloned object.

fn clone_in_impl( &self, with_semantic_ids: CloneInSemanticIds, _: &'alloc Allocator, ) -> SymbolId

Clone self into allocator, threading whether semantic ids should be preserved as a runtime with_semantic_ids flag rather than as two separate methods.

fn clone_in(&self, allocator: &'new_alloc Allocator) -> Self::Cloned

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

fn clone_in_with_semantic_ids( &self, allocator: &'new_alloc Allocator, ) -> Self::Cloned

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 Copy for SymbolId

impl Debug for SymbolId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SymbolId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SymbolId

impl From<usize> for SymbolId

fn from(value: usize) -> SymbolId

Converts to this type from the input type.

impl Hash for SymbolId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 SymbolId

const MAX: usize = Self::MAX_INDEX

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

unsafe fn from_usize_unchecked(idx: usize) -> SymbolId

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 SymbolId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<usize> for SymbolId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SymbolId

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

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 Rem<usize> for SymbolId

type Output = SymbolId

The resulting type after applying the % operator.

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

Performs the % operation.

impl SemanticId for SymbolId

fn clone_id(&self, with_semantic_ids: CloneInSemanticIds) -> Self

Clone a semantic ID.

fn clone_cell_option_id( cell: &Cell<Option<Self>>, with_semantic_ids: CloneInSemanticIds, ) -> Cell<Option<Self>>

Clone a Cell<Option<Id>> semantic ID field.

impl Serialize for SymbolId

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SymbolId

impl Sub for SymbolId

type Output = SymbolId

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for SymbolId

type Output = SymbolId

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for SymbolId

fn sub_assign(&mut self, other: SymbolId)

Performs the -= operation.

impl SubAssign<usize> for SymbolId

fn sub_assign(&mut self, other: usize)

Performs the -= operation.