Struct rustc_span::symbol::Symbol[][src]

pub struct Symbol(SymbolIndex);

An interned string.

Internally, a Symbol is implemented as an index, and all operations (including hashing, equality, and ordering) operate on that index. The use of rustc_index::newtype_index! means that Option<Symbol> only takes up 4 bytes, because rustc_index::newtype_index! reserves the last 256 values for tagging purposes.

Note that Symbol cannot directly be a rustc_index::newtype_index! because it implements fmt::Debug, Encodable, and Decodable in special ways.


impl Symbol[src]

const fn new(n: u32) -> Self[src]

pub fn intern(string: &str) -> Self[src]

Maps a string to its interned representation.

pub fn as_str(self) -> SymbolStr[src]

Convert to a SymbolStr. This is a slowish operation because it requires locking the symbol interner.

pub fn as_u32(self) -> u32[src]

pub fn is_empty(self) -> bool[src]

pub fn to_ident_string(self) -> String[src]

This method is supposed to be used in error messages, so it’s expected to be identical to printing the original identifier token written in source code (token_to_string, Ident::to_string), except that symbols don’t keep the rawness flag or edition, so we have to guess the rawness using the global edition.

impl Symbol[src]

fn is_special(self) -> bool[src]

fn is_used_keyword_always(self) -> bool[src]

fn is_used_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool[src]

fn is_unused_keyword_always(self) -> bool[src]

fn is_unused_keyword_conditional(
    edition: impl FnOnce() -> Edition
) -> bool

pub fn is_reserved(self, edition: impl Copy + FnOnce() -> Edition) -> bool[src]

pub fn is_path_segment_keyword(self) -> bool[src]

A keyword or reserved identifier that can be used as a path segment.

pub fn is_bool_lit(self) -> bool[src]

Returns true if the symbol is true or false.

pub fn can_be_raw(self) -> bool[src]

Returns true if this symbol can be a raw identifier.

Trait Implementations

impl Clone for Symbol[src]

impl Copy for Symbol[src]

impl Debug for Symbol[src]

impl<D: Decoder> Decodable<D> for Symbol[src]

impl Display for Symbol[src]

impl<S: Encoder> Encodable<S> for Symbol[src]

impl Eq for Symbol[src]

impl Hash for Symbol[src]

impl<CTX> HashStable<CTX> for Symbol[src]

impl Ord for Symbol[src]

impl PartialEq<Symbol> for Symbol[src]

impl PartialOrd<Symbol> for Symbol[src]

impl StructuralEq for Symbol[src]

impl StructuralPartialEq for Symbol[src]

impl<CTX> ToStableHashKey<CTX> for Symbol[src]

Auto Trait Implementations

impl RefUnwindSafe for Symbol

impl Send for Symbol

impl Sync for Symbol

impl Unpin for Symbol

impl UnwindSafe for Symbol

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.