Struct Symbol

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

Default unique identifier for a string in an Interner.

Implementations

impl Symbol

pub fn new(id: u32) -> Self

Creates a new Symbol from a u32.

Panics

Panics if id is u32::MAX.

pub fn try_new(id: u32) -> Option<Self>

Tries to create a new Symbol from a u32.

pub fn from_usize(id: usize) -> Self

Creates a new Symbol from a usize.

Panics

Panics if id is greater than or equal to u32::MAX.

pub fn try_from_usize(id: usize) -> Option<Self>

Tries to create a new Symbol from a usize.

pub unsafe fn new_unchecked(id: u32) -> Self

Creates a new Symbol from a u32 without checking if it is valid.

Safety

The caller must ensure that id is less than u32::MAX.

pub fn get(self) -> u32

Returns the u32 value of the Symbol.

pub fn to_usize(self) -> usize

Returns the usize value of the Symbol.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Hash for Symbol

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 InternerSymbol for Symbol

fn try_from_usize(id: usize) -> Option<Self>

Tries to create a new Symbol from a usize.

fn to_usize(self) -> usize

Converts the Symbol to a usize.

fn from_usize(id: usize) -> Self

Creates a new Symbol from a usize.

impl Ord for Symbol

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

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

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

impl Eq for Symbol

impl StructuralPartialEq for Symbol