[][src]Struct syntax::source_map::symbol::Symbol

pub struct Symbol(SymbolIndex);
⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

A symbol is an interned or gensymed string. A gensym is a symbol that is never equal to any other symbol.

Conceptually, a gensym can be thought of as a normal symbol with an invisible unique suffix. Gensyms are useful when creating new identifiers that must not match any existing identifiers, e.g. during macro expansion and syntax desugaring. Because gensyms should always be identifiers, all gensym operations are on Ident rather than Symbol. (Indeed, in the future the gensym-ness may be moved from Symbol to hygiene data.)

Examples:

assert_eq!(Ident::from_str("_"), Ident::from_str("_"))
assert_ne!(Ident::from_str("_").gensym_if_underscore(), Ident::from_str("_"))
assert_ne!(
    Ident::from_str("_").gensym_if_underscore(),
    Ident::from_str("_").gensym_if_underscore(),
)

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.

Methods

impl Symbol[src]

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Maps a string to its interned representation.

pub fn with<F, R>(self, f: F) -> R where
    F: FnOnce(&str) -> R, 
[src]

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Access the symbol's chars. This is a slowish operation because it requires locking the symbol interner.

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

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

pub fn as_interned_str(self) -> InternedString[src]

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

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

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

impl Symbol[src]

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Used for sanity checking rustdoc keyword sections.

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

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

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

Returns true if the symbol is true or false.

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

⚙️ This is an internal compiler API. (rustc_private)

This crate is being loaded from the sysroot, a permanently unstable location for private compiler dependencies. It is not intended for general use. Prefer using a public version of this crate from crates.io via Cargo.toml.

This symbol can be a raw identifier.

Trait Implementations

impl Decodable for Symbol[src]

impl Clone for Symbol[src]

impl Ord for Symbol[src]

impl Eq for Symbol[src]

impl PartialOrd<Symbol> for Symbol[src]

impl Debug for Symbol[src]

impl Hash for Symbol[src]

impl Display for Symbol[src]

impl Encodable for Symbol[src]

impl Copy for Symbol[src]

impl PartialEq<Symbol> for Symbol[src]

impl PartialEq<Symbol> for Path[src]

Auto Trait Implementations

impl Send for Symbol

impl Sync for Symbol

impl Unpin for Symbol

impl UnwindSafe for Symbol

impl RefUnwindSafe for Symbol

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

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

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

impl<T> Erased for T[src]

impl<T> Encodable for T where
    T: UseSpecializedEncodable + ?Sized
[src]

impl<T> Decodable for T where
    T: UseSpecializedDecodable
[src]

impl<E> SpecializationError for E[src]

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized
[src]