Struct Symbol

pub struct Symbol(NonZero<u32>);

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

Handle for a symbol string stored within the Interner.

Tuple Fields

0: NonZero<u32>

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

Implementations

impl Symbol

pub(crate) fn normalize_and_validate_ident(string: &str) -> Result<Symbol, ()>

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

impl Symbol

pub(crate) fn new(string: &str) -> Self

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

Intern a new Symbol

pub(crate) fn new_ident(string: &str, is_raw: bool) -> Self

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

Creates a new Symbol for an identifier.

Validates and normalizes before converting it to a symbol.

pub(crate) fn with<R>(self, f: impl FnOnce(&str) -> R) -> R

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

Run a callback with the symbol’s string value.

pub(crate) fn invalidate_all()

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

Clear out the thread-local symbol interner, making all previously created symbols invalid such that with will panic when called on them.

fn is_valid_ascii_ident(bytes: &[u8]) -> bool

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

Checks if the ident is a valid ASCII identifier.

This is a short-circuit which is cheap to implement within the proc-macro client to avoid RPC when creating simple idents, but may return false for a valid identifier if it contains non-ASCII characters.

fn can_be_raw(string: &str) -> bool

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy 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<S> DecodeMut<'_, '_, S> for Symbol

fn decode(r: &mut &'_ [u8], s: &mut S) -> Self

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

impl Display for Symbol

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

Formats the value using the given formatter.

impl<S> Encode<S> for Symbol

fn encode(self, w: &mut Buffer, s: &mut S)

🔬This is a nightly-only experimental API. (proc_macro_internals #27812)

impl Eq for Symbol

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

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

impl !Send for Symbol

impl StructuralPartialEq for Symbol

impl !Sync for Symbol