Struct syntax::symbol::SymbolIndex

pub struct SymbolIndex { /* fields omitted */ }

Methods

impl SymbolIndex

pub const MAX_AS_U32: u32

pub const MAX: SymbolIndex

pub fn from_usize(value: usize) -> SymbolIndex

pub fn from_u32(value: u32) -> SymbolIndex

pub fn from_u32_const(value: u32) -> SymbolIndex

Hacky variant of from_u32 for use in constants. This version checks the "max" constraint by using an invalid array dereference.

pub unsafe fn from_u32_unchecked(value: u32) -> SymbolIndex

pub fn index(self) -> usize

Extracts the value of this index as an integer.

pub fn as_u32(self) -> u32

Extracts the value of this index as a u32.

pub fn as_usize(self) -> usize

Extracts the value of this index as a usize.

Trait Implementations

impl Decodable for SymbolIndex

fn decode<D>(d: &mut D) -> Result<SymbolIndex, <D as Decoder>::Error> where
    D: Decoder, 

impl Step for SymbolIndex

fn steps_between(start: &SymbolIndex, end: &SymbolIndex) -> Option<usize>

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

likely to be replaced by finer-grained traits

Returns the number of steps between two step objects. The count is inclusive of start and exclusive of end.

fn replace_one(&mut self) -> SymbolIndex

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

likely to be replaced by finer-grained traits

Replaces this step with 1, returning itself.

fn replace_zero(&mut self) -> SymbolIndex

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

likely to be replaced by finer-grained traits

Replaces this step with 0, returning itself.

fn add_one(&self) -> SymbolIndex

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

likely to be replaced by finer-grained traits

Adds one to this step, returning the result.

fn sub_one(&self) -> SymbolIndex

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

likely to be replaced by finer-grained traits

Subtracts one to this step, returning the result.

fn add_usize(&self, u: usize) -> Option<SymbolIndex>

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

likely to be replaced by finer-grained traits

Adds a usize, returning None on overflow.

fn sub_usize(&self, u: usize) -> Option<SymbolIndex>

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

likely to be replaced by finer-grained traits

Subtracts a usize, returning None on underflow.

impl PartialOrd<SymbolIndex> for SymbolIndex

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

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

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

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

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

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

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

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

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

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

impl Ord for SymbolIndex

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

impl Clone for SymbolIndex

fn clone(&self) -> SymbolIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolIndex

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

Formats the value using the given formatter.

impl Encodable for SymbolIndex

fn encode<__S>(&self, s: &mut __S) -> Result<(), <__S as Encoder>::Error> where
    __S: Encoder, 

impl Hash for SymbolIndex

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, 

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

impl Copy for SymbolIndex

impl Add<usize> for SymbolIndex

type Output = SymbolIndex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Idx for SymbolIndex

fn new(value: usize) -> SymbolIndex

fn index(self) -> usize

fn increment_by(&mut self, amount: usize)

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

impl From<u32> for SymbolIndex

fn from(value: u32) -> SymbolIndex

Performs the conversion.

impl From<usize> for SymbolIndex

fn from(value: usize) -> SymbolIndex

Performs the conversion.

impl PartialEq<SymbolIndex> for SymbolIndex

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

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

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

This method tests for !=.