1 //! An "interner" is a data structure that associates values with usize tags and
2 //! allows bidirectional lookup; i.e., given a value, one can easily find the
3 //! type, and vice versa.
5 use rustc_arena::DroplessArena;
6 use rustc_data_structures::fx::FxHashMap;
7 use rustc_data_structures::stable_hasher::{HashStable, StableHasher, ToStableHashKey};
8 use rustc_data_structures::sync::Lock;
9 use rustc_macros::HashStable_Generic;
10 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
12 use std::cmp::{Ord, PartialEq, PartialOrd};
14 use std::hash::{Hash, Hasher};
17 use crate::{with_session_globals, Edition, Span, DUMMY_SP};
22 // The proc macro code for this is in `compiler/rustc_macros/src/symbols.rs`.
24 // After modifying this list adjust `is_special`, `is_used_keyword`/`is_unused_keyword`,
25 // this should be rarely necessary though if the keywords are kept in alphabetic order.
27 // Special reserved identifiers used internally for elided lifetimes,
28 // unnamed method parameters, crate root module, error recovery etc.
31 DollarCrate: "$crate",
34 // Keywords that are used in stable Rust.
71 // Keywords that are used in unstable Rust or reserved for future use.
85 // Edition-specific keywords that are used in stable Rust.
86 Async: "async", // >= 2018 Edition only
87 Await: "await", // >= 2018 Edition only
88 Dyn: "dyn", // >= 2018 Edition only
90 // Edition-specific keywords that are used in unstable Rust or reserved for future use.
91 Try: "try", // >= 2018 Edition only
93 // Special lifetime names
94 UnderscoreLifetime: "'_",
95 StaticLifetime: "'static",
97 // Weak keywords, have special meaning only in specific contexts.
101 MacroRules: "macro_rules",
106 // Pre-interned symbols that can be referred to with `rustc_span::sym::*`.
108 // The symbol is the stringified identifier unless otherwise specified, in
109 // which case the name should mention the non-identifier punctuation.
110 // E.g. `sym::proc_dash_macro` represents "proc-macro", and it shouldn't be
111 // called `sym::proc_macro` because then it's easy to mistakenly think it
112 // represents "proc_macro".
114 // As well as the symbols listed, there are symbols for the strings
115 // "0", "1", ..., "9", which are accessible via `sym::integer`.
117 // The proc macro will abort if symbols are not in alphabetical order (as
118 // defined by `impl Ord for str`) or if any symbols are duplicated. Vim
119 // users can sort the list by selecting it and executing the command
120 // `:'<,'>!LC_ALL=C sort`.
122 // There is currently no checking that all symbols are used; that would be
229 ProceduralMasqueradeDummyType,
278 aarch64_target_feature,
282 abi_c_cmse_nonsecure_call,
284 abi_msp430_interrupt,
298 advanced_slice_patterns,
314 allow_internal_unsafe,
315 allow_internal_unstable,
321 arbitrary_enum_discriminant,
322 arbitrary_self_types,
332 asm_experimental_arch,
337 assert_receiver_is_total_eq,
341 associated_type_bounds,
342 associated_type_defaults,
355 augmented_assignments,
357 automatically_derived,
358 avx512_target_feature,
364 bind_by_move_pattern_guards,
376 borrowck_graphviz_format,
377 borrowck_graphviz_postflow,
378 borrowck_graphviz_preflow,
383 braced_empty_structs,
395 capture_disjoint_fields,
410 cfg_target_has_atomic,
411 cfg_target_thread_local,
423 closure_to_fn_coercion,
424 closure_track_caller,
428 cmpxchg16b_target_feature,
429 cmse_nonsecure_entry,
435 compare_exchange_weak,
441 conservative_impl_trait,
445 const_compare_raw_pointers,
449 const_eval_select_ct,
450 const_evaluatable_checked,
453 const_fn_floating_point_arithmetic,
454 const_fn_fn_ptr_basics,
455 const_fn_trait_bound,
461 const_generic_defaults,
463 const_generics_defaults,
466 const_in_array_repeat_expressions,
473 const_precise_live_drops,
476 const_raw_ptr_to_usize_cast,
479 const_trait_bound_opt_out,
496 core_panic_2015_macro,
506 crate_visibility_modifier,
507 crt_dash_static: "crt-static",
516 custom_inner_attributes,
517 custom_test_frameworks,
530 default_alloc_error_handler,
531 default_lib_allocator,
532 default_method_body_is_const,
533 default_type_parameter_fallback,
535 delay_span_bug_from_inside_query,
544 destructuring_assignment,
565 document_private_items,
566 dotdot_in_tuple_patterns,
567 dotdoteq_in_patterns,
575 dropck_parametricity,
585 emit_enum_variant_arg,
593 ermsb_target_feature,
597 exclusive_range_pattern,
598 exhaustive_integer_patterns,
607 explicit_generic_args_with_impl_trait,
610 extended_key_value_attributes,
611 extern_absolute_paths,
612 extern_crate_item_prelude,
636 field_init_shorthand,
641 float_to_int_unchecked,
672 from_size_align_unchecked,
685 generic_associated_types,
693 half_open_range_patterns,
695 hexagon_target_feature,
697 homogeneous_aggregate,
714 if_while_or_patterns,
716 impl_header_lifetime_elision,
719 impl_trait_in_bindings,
726 inclusive_range_syntax,
729 infer_outlives_requirements,
730 infer_static_outlives_requirements,
731 inherent_associated_types,
741 irrefutable_let_patterns,
745 issue_5723_bootstrap,
746 issue_tracker_base_url,
760 lazy_normalization_consts,
774 link_llvm_intrinsics,
794 macro_at_most_once_rep,
795 macro_attributes_in_derive_output,
798 macro_lifetime_matcher,
799 macro_literal_matcher,
811 match_beginning_vert,
812 match_default_bindings,
839 min_type_alias_impl_trait,
848 more_qualified_paths,
850 movbe_target_feature,
863 native_link_modifiers,
864 native_link_modifiers_as_needed,
865 native_link_modifiers_bundle,
866 native_link_modifiers_verbatim,
867 native_link_modifiers_whole_archive,
904 non_exhaustive_omitted_patterns_lint,
916 object_safe_for_dispatch,
919 omit_gdb_pretty_printer_section,
928 optin_builtin_traits,
936 overlapping_marker_traits,
948 panic_implementation,
975 post_dash_lto: "post-lto",
976 powerpc_target_feature,
981 pre_dash_lto: "pre-lto",
982 precise_pointer_size_matching,
986 prefetch_read_instruction,
988 prefetch_write_instruction,
994 proc_dash_macro: "proc-macro",
996 proc_macro_attribute,
1002 proc_macro_internals,
1004 proc_macro_non_items,
1005 proc_macro_path_invoc,
1020 quad_precision_float,
1023 range_inclusive_new,
1028 re_rebalance_coherence,
1031 read_enum_variant_arg,
1039 reexport_test_harness_main,
1040 ref_unwind_safe_trait,
1054 relaxed_struct_unsize,
1070 riscv_target_feature,
1086 rust_eh_catch_typeinfo,
1087 rust_eh_personality,
1088 rust_eh_register_frames,
1089 rust_eh_unregister_frames,
1093 rustc_allocator_nounwind,
1094 rustc_allow_const_fn_unstable,
1096 rustc_builtin_macro,
1097 rustc_capture_analysis,
1100 rustc_const_unstable,
1101 rustc_conversion_suggestion,
1104 rustc_diagnostic_item,
1105 rustc_diagnostic_macros,
1107 rustc_do_not_const_check,
1109 rustc_dump_env_program_clauses,
1110 rustc_dump_program_clauses,
1111 rustc_dump_user_substs,
1114 rustc_evaluate_where_clauses,
1115 rustc_expected_cgu_reuse,
1116 rustc_if_this_changed,
1117 rustc_inherit_overflow_checks,
1118 rustc_insignificant_dtor,
1120 rustc_layout_scalar_valid_range_end,
1121 rustc_layout_scalar_valid_range_start,
1122 rustc_legacy_const_generics,
1123 rustc_macro_transparency,
1126 rustc_nonnull_optimization_guaranteed,
1127 rustc_object_lifetime_default,
1128 rustc_on_unimplemented,
1131 rustc_partition_codegened,
1132 rustc_partition_reused,
1134 rustc_peek_definite_init,
1135 rustc_peek_liveness,
1136 rustc_peek_maybe_init,
1137 rustc_peek_maybe_uninit,
1138 rustc_polymorphize_error,
1140 rustc_proc_macro_decls,
1143 rustc_reservation_impl,
1145 rustc_skip_array_during_method_dispatch,
1146 rustc_specialization_trait,
1148 rustc_std_internal_symbol,
1149 rustc_strict_coherence,
1152 rustc_then_this_would_need,
1153 rustc_trivial_field_reads,
1154 rustc_unsafe_specialization_marker,
1158 rvalue_static_promotion,
1207 simd_reduce_add_ordered,
1208 simd_reduce_add_unordered,
1213 simd_reduce_max_nanless,
1215 simd_reduce_min_nanless,
1216 simd_reduce_mul_ordered,
1217 simd_reduce_mul_unordered,
1222 simd_saturating_add,
1223 simd_saturating_sub,
1226 simd_select_bitmask,
1256 sse4a_target_feature,
1268 std_panic_2015_macro,
1271 stmt_expr_attributes,
1272 stop_after_dataflow,
1277 struct_field_attributes,
1299 target_has_atomic_equal_alignment,
1300 target_has_atomic_load_store,
1302 target_pointer_width,
1303 target_target_vendor,
1304 target_thread_local,
1310 termination_trait_test,
1313 test_accepted_feature,
1315 test_removed_feature,
1343 type_alias_enum_variants,
1344 type_alias_impl_trait,
1346 type_changing_struct_update,
1356 unaligned_volatile_load,
1357 unaligned_volatile_store,
1366 underscore_const_names,
1368 underscore_lifetimes,
1371 universal_impl_trait,
1378 unrestricted_attribute_tokens,
1379 unsafe_block_in_unsafe_fn,
1381 unsafe_no_drop_flag,
1385 unsized_tuple_coercion,
1388 unused_qualifications,
1410 visible_private_types,
1412 volatile_copy_memory,
1413 volatile_copy_nonoverlapping_memory,
1415 volatile_set_memory,
1422 wasm_target_feature,
1441 #[derive(Copy, Clone, Eq, HashStable_Generic, Encodable, Decodable)]
1449 /// Constructs a new identifier from a symbol and a span.
1450 pub const fn new(name: Symbol, span: Span) -> Ident {
1451 Ident { name, span }
1454 /// Constructs a new identifier with a dummy span.
1456 pub const fn with_dummy_span(name: Symbol) -> Ident {
1457 Ident::new(name, DUMMY_SP)
1461 pub fn empty() -> Ident {
1462 Ident::with_dummy_span(kw::Empty)
1465 /// Maps a string to an identifier with a dummy span.
1466 pub fn from_str(string: &str) -> Ident {
1467 Ident::with_dummy_span(Symbol::intern(string))
1470 /// Maps a string and a span to an identifier.
1471 pub fn from_str_and_span(string: &str, span: Span) -> Ident {
1472 Ident::new(Symbol::intern(string), span)
1475 /// Replaces `lo` and `hi` with those from `span`, but keep hygiene context.
1476 pub fn with_span_pos(self, span: Span) -> Ident {
1477 Ident::new(self.name, span.with_ctxt(self.span.ctxt()))
1480 pub fn without_first_quote(self) -> Ident {
1481 Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
1484 /// "Normalize" ident for use in comparisons using "item hygiene".
1485 /// Identifiers with same string value become same if they came from the same macro 2.0 macro
1486 /// (e.g., `macro` item, but not `macro_rules` item) and stay different if they came from
1487 /// different macro 2.0 macros.
1488 /// Technically, this operation strips all non-opaque marks from ident's syntactic context.
1489 pub fn normalize_to_macros_2_0(self) -> Ident {
1490 Ident::new(self.name, self.span.normalize_to_macros_2_0())
1493 /// "Normalize" ident for use in comparisons using "local variable hygiene".
1494 /// Identifiers with same string value become same if they came from the same non-transparent
1495 /// macro (e.g., `macro` or `macro_rules!` items) and stay different if they came from different
1496 /// non-transparent macros.
1497 /// Technically, this operation strips all transparent marks from ident's syntactic context.
1498 pub fn normalize_to_macro_rules(self) -> Ident {
1499 Ident::new(self.name, self.span.normalize_to_macro_rules())
1502 /// Convert the name to a `SymbolStr`. This is a slowish operation because
1503 /// it requires locking the symbol interner.
1504 pub fn as_str(self) -> SymbolStr {
1509 impl PartialEq for Ident {
1510 fn eq(&self, rhs: &Self) -> bool {
1511 self.name == rhs.name && self.span.ctxt() == rhs.span.ctxt()
1515 impl Hash for Ident {
1516 fn hash<H: Hasher>(&self, state: &mut H) {
1517 self.name.hash(state);
1518 self.span.ctxt().hash(state);
1522 impl fmt::Debug for Ident {
1523 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1524 fmt::Display::fmt(self, f)?;
1525 fmt::Debug::fmt(&self.span.ctxt(), f)
1529 /// This implementation is supposed to be used in error messages, so it's expected to be identical
1530 /// to printing the original identifier token written in source code (`token_to_string`),
1531 /// except that AST identifiers don't keep the rawness flag, so we have to guess it.
1532 impl fmt::Display for Ident {
1533 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1534 fmt::Display::fmt(&IdentPrinter::new(self.name, self.is_raw_guess(), None), f)
1538 /// This is the most general way to print identifiers.
1539 /// AST pretty-printer is used as a fallback for turning AST structures into token streams for
1540 /// proc macros. Additionally, proc macros may stringify their input and expect it survive the
1541 /// stringification (especially true for proc macro derives written between Rust 1.15 and 1.30).
1542 /// So we need to somehow pretty-print `$crate` in a way preserving at least some of its
1543 /// hygiene data, most importantly name of the crate it refers to.
1544 /// As a result we print `$crate` as `crate` if it refers to the local crate
1545 /// and as `::other_crate_name` if it refers to some other crate.
1546 /// Note, that this is only done if the ident token is printed from inside of AST pretty-pringing,
1547 /// but not otherwise. Pretty-printing is the only way for proc macros to discover token contents,
1548 /// so we should not perform this lossy conversion if the top level call to the pretty-printer was
1549 /// done for a token stream or a single token.
1550 pub struct IdentPrinter {
1553 /// Span used for retrieving the crate name to which `$crate` refers to,
1554 /// if this field is `None` then the `$crate` conversion doesn't happen.
1555 convert_dollar_crate: Option<Span>,
1559 /// The most general `IdentPrinter` constructor. Do not use this.
1560 pub fn new(symbol: Symbol, is_raw: bool, convert_dollar_crate: Option<Span>) -> IdentPrinter {
1561 IdentPrinter { symbol, is_raw, convert_dollar_crate }
1564 /// This implementation is supposed to be used when printing identifiers
1565 /// as a part of pretty-printing for larger AST pieces.
1566 /// Do not use this either.
1567 pub fn for_ast_ident(ident: Ident, is_raw: bool) -> IdentPrinter {
1568 IdentPrinter::new(ident.name, is_raw, Some(ident.span))
1572 impl fmt::Display for IdentPrinter {
1573 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1576 } else if self.symbol == kw::DollarCrate {
1577 if let Some(span) = self.convert_dollar_crate {
1578 let converted = span.ctxt().dollar_crate_name();
1579 if !converted.is_path_segment_keyword() {
1582 return fmt::Display::fmt(&converted, f);
1585 fmt::Display::fmt(&self.symbol, f)
1589 /// An newtype around `Ident` that calls [Ident::normalize_to_macro_rules] on
1591 // FIXME(matthewj, petrochenkov) Use this more often, add a similar
1592 // `ModernIdent` struct and use that as well.
1593 #[derive(Copy, Clone, Eq, PartialEq, Hash)]
1594 pub struct MacroRulesNormalizedIdent(Ident);
1596 impl MacroRulesNormalizedIdent {
1597 pub fn new(ident: Ident) -> Self {
1598 Self(ident.normalize_to_macro_rules())
1602 impl fmt::Debug for MacroRulesNormalizedIdent {
1603 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1604 fmt::Debug::fmt(&self.0, f)
1608 impl fmt::Display for MacroRulesNormalizedIdent {
1609 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1610 fmt::Display::fmt(&self.0, f)
1614 /// An interned string.
1616 /// Internally, a `Symbol` is implemented as an index, and all operations
1617 /// (including hashing, equality, and ordering) operate on that index. The use
1618 /// of `rustc_index::newtype_index!` means that `Option<Symbol>` only takes up 4 bytes,
1619 /// because `rustc_index::newtype_index!` reserves the last 256 values for tagging purposes.
1621 /// Note that `Symbol` cannot directly be a `rustc_index::newtype_index!` because it
1622 /// implements `fmt::Debug`, `Encodable`, and `Decodable` in special ways.
1623 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
1624 pub struct Symbol(SymbolIndex);
1626 rustc_index::newtype_index! {
1627 struct SymbolIndex { .. }
1631 const fn new(n: u32) -> Self {
1632 Symbol(SymbolIndex::from_u32(n))
1635 /// Maps a string to its interned representation.
1636 pub fn intern(string: &str) -> Self {
1637 with_session_globals(|session_globals| session_globals.symbol_interner.intern(string))
1640 /// Convert to a `SymbolStr`. This is a slowish operation because it
1641 /// requires locking the symbol interner.
1642 pub fn as_str(self) -> SymbolStr {
1643 with_session_globals(|session_globals| {
1644 let symbol_str = session_globals.symbol_interner.get(self);
1645 unsafe { SymbolStr { string: std::mem::transmute::<&str, &str>(symbol_str) } }
1649 pub fn as_u32(self) -> u32 {
1653 pub fn is_empty(self) -> bool {
1657 /// This method is supposed to be used in error messages, so it's expected to be
1658 /// identical to printing the original identifier token written in source code
1659 /// (`token_to_string`, `Ident::to_string`), except that symbols don't keep the rawness flag
1660 /// or edition, so we have to guess the rawness using the global edition.
1661 pub fn to_ident_string(self) -> String {
1662 Ident::with_dummy_span(self).to_string()
1666 impl fmt::Debug for Symbol {
1667 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1668 fmt::Debug::fmt(&self.as_str(), f)
1672 impl fmt::Display for Symbol {
1673 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1674 fmt::Display::fmt(&self.as_str(), f)
1678 impl<S: Encoder> Encodable<S> for Symbol {
1679 fn encode(&self, s: &mut S) -> Result<(), S::Error> {
1680 s.emit_str(&self.as_str())
1684 impl<D: Decoder> Decodable<D> for Symbol {
1686 fn decode(d: &mut D) -> Result<Symbol, D::Error> {
1687 Ok(Symbol::intern(&d.read_str()?))
1691 impl<CTX> HashStable<CTX> for Symbol {
1693 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1694 self.as_str().hash_stable(hcx, hasher);
1698 impl<CTX> ToStableHashKey<CTX> for Symbol {
1699 type KeyType = SymbolStr;
1702 fn to_stable_hash_key(&self, _: &CTX) -> SymbolStr {
1708 pub(crate) struct Interner(Lock<InternerInner>);
1710 // The `&'static str`s in this type actually point into the arena.
1712 // The `FxHashMap`+`Vec` pair could be replaced by `FxIndexSet`, but #75278
1713 // found that to regress performance up to 2% in some cases. This might be
1714 // revisited after further improvements to `indexmap`.
1716 // This type is private to prevent accidentally constructing more than one `Interner` on the same
1717 // thread, which makes it easy to mixup `Symbol`s between `Interner`s.
1719 struct InternerInner {
1720 arena: DroplessArena,
1721 names: FxHashMap<&'static str, Symbol>,
1722 strings: Vec<&'static str>,
1726 fn prefill(init: &[&'static str]) -> Self {
1727 Interner(Lock::new(InternerInner {
1728 strings: init.into(),
1729 names: init.iter().copied().zip((0..).map(Symbol::new)).collect(),
1730 ..Default::default()
1735 fn intern(&self, string: &str) -> Symbol {
1736 let mut inner = self.0.lock();
1737 if let Some(&name) = inner.names.get(string) {
1741 let name = Symbol::new(inner.strings.len() as u32);
1743 // `from_utf8_unchecked` is safe since we just allocated a `&str` which is known to be
1746 unsafe { str::from_utf8_unchecked(inner.arena.alloc_slice(string.as_bytes())) };
1747 // It is safe to extend the arena allocation to `'static` because we only access
1748 // these while the arena is still alive.
1749 let string: &'static str = unsafe { &*(string as *const str) };
1750 inner.strings.push(string);
1751 inner.names.insert(string, name);
1755 // Get the symbol as a string. `Symbol::as_str()` should be used in
1756 // preference to this function.
1757 fn get(&self, symbol: Symbol) -> &str {
1758 self.0.lock().strings[symbol.0.as_usize()]
1762 // This module has a very short name because it's used a lot.
1763 /// This module contains all the defined keyword `Symbol`s.
1765 /// Given that `kw` is imported, use them like `kw::keyword_name`.
1766 /// For example `kw::Loop` or `kw::Break`.
1768 pub use super::kw_generated::*;
1771 // This module has a very short name because it's used a lot.
1772 /// This module contains all the defined non-keyword `Symbol`s.
1774 /// Given that `sym` is imported, use them like `sym::symbol_name`.
1775 /// For example `sym::rustfmt` or `sym::u8`.
1778 use std::convert::TryInto;
1781 pub use super::sym_generated::*;
1783 // Used from a macro in `librustc_feature/accepted.rs`
1784 pub use super::kw::MacroRules as macro_rules;
1786 /// Get the symbol for an integer.
1788 /// The first few non-negative integers each have a static symbol and therefore
1790 pub fn integer<N: TryInto<usize> + Copy + ToString>(n: N) -> Symbol {
1791 if let Result::Ok(idx) = n.try_into() {
1793 return Symbol::new(super::SYMBOL_DIGITS_BASE + idx as u32);
1796 Symbol::intern(&n.to_string())
1801 fn is_special(self) -> bool {
1802 self <= kw::Underscore
1805 fn is_used_keyword_always(self) -> bool {
1806 self >= kw::As && self <= kw::While
1809 fn is_used_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
1810 (self >= kw::Async && self <= kw::Dyn) && edition() >= Edition::Edition2018
1813 fn is_unused_keyword_always(self) -> bool {
1814 self >= kw::Abstract && self <= kw::Yield
1817 fn is_unused_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
1818 self == kw::Try && edition() >= Edition::Edition2018
1821 pub fn is_reserved(self, edition: impl Copy + FnOnce() -> Edition) -> bool {
1823 || self.is_used_keyword_always()
1824 || self.is_unused_keyword_always()
1825 || self.is_used_keyword_conditional(edition)
1826 || self.is_unused_keyword_conditional(edition)
1829 /// A keyword or reserved identifier that can be used as a path segment.
1830 pub fn is_path_segment_keyword(self) -> bool {
1832 || self == kw::SelfLower
1833 || self == kw::SelfUpper
1834 || self == kw::Crate
1835 || self == kw::PathRoot
1836 || self == kw::DollarCrate
1839 /// Returns `true` if the symbol is `true` or `false`.
1840 pub fn is_bool_lit(self) -> bool {
1841 self == kw::True || self == kw::False
1844 /// Returns `true` if this symbol can be a raw identifier.
1845 pub fn can_be_raw(self) -> bool {
1846 self != kw::Empty && self != kw::Underscore && !self.is_path_segment_keyword()
1851 // Returns `true` for reserved identifiers used internally for elided lifetimes,
1852 // unnamed method parameters, crate root module, error recovery etc.
1853 pub fn is_special(self) -> bool {
1854 self.name.is_special()
1857 /// Returns `true` if the token is a keyword used in the language.
1858 pub fn is_used_keyword(self) -> bool {
1859 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1860 self.name.is_used_keyword_always()
1861 || self.name.is_used_keyword_conditional(|| self.span.edition())
1864 /// Returns `true` if the token is a keyword reserved for possible future use.
1865 pub fn is_unused_keyword(self) -> bool {
1866 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1867 self.name.is_unused_keyword_always()
1868 || self.name.is_unused_keyword_conditional(|| self.span.edition())
1871 /// Returns `true` if the token is either a special identifier or a keyword.
1872 pub fn is_reserved(self) -> bool {
1873 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1874 self.name.is_reserved(|| self.span.edition())
1877 /// A keyword or reserved identifier that can be used as a path segment.
1878 pub fn is_path_segment_keyword(self) -> bool {
1879 self.name.is_path_segment_keyword()
1882 /// We see this identifier in a normal identifier position, like variable name or a type.
1883 /// How was it written originally? Did it use the raw form? Let's try to guess.
1884 pub fn is_raw_guess(self) -> bool {
1885 self.name.can_be_raw() && self.is_reserved()
1889 /// An alternative to [`Symbol`], useful when the chars within the symbol need to
1890 /// be accessed. It deliberately has limited functionality and should only be
1891 /// used for temporary values.
1893 /// Because the interner outlives any thread which uses this type, we can
1894 /// safely treat `string` which points to interner data, as an immortal string,
1895 /// as long as this type never crosses between threads.
1897 // FIXME: ensure that the interner outlives any thread which uses `SymbolStr`,
1898 // by creating a new thread right after constructing the interner.
1899 #[derive(Clone, Eq, PartialOrd, Ord)]
1900 pub struct SymbolStr {
1901 string: &'static str,
1904 // This impl allows a `SymbolStr` to be directly equated with a `String` or
1906 impl<T: std::ops::Deref<Target = str>> std::cmp::PartialEq<T> for SymbolStr {
1907 fn eq(&self, other: &T) -> bool {
1908 self.string == other.deref()
1912 impl !Send for SymbolStr {}
1913 impl !Sync for SymbolStr {}
1915 /// This impl means that if `ss` is a `SymbolStr`:
1916 /// - `*ss` is a `str`;
1917 /// - `&*ss` is a `&str` (and `match &*ss { ... }` is a common pattern).
1918 /// - `&ss as &str` is a `&str`, which means that `&ss` can be passed to a
1919 /// function expecting a `&str`.
1920 impl std::ops::Deref for SymbolStr {
1923 fn deref(&self) -> &str {
1928 impl fmt::Debug for SymbolStr {
1929 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1930 fmt::Debug::fmt(self.string, f)
1934 impl fmt::Display for SymbolStr {
1935 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1936 fmt::Display::fmt(self.string, f)
1940 impl<CTX> HashStable<CTX> for SymbolStr {
1942 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1943 self.string.hash_stable(hcx, hasher)
1947 impl<CTX> ToStableHashKey<CTX> for SymbolStr {
1948 type KeyType = SymbolStr;
1951 fn to_stable_hash_key(&self, _: &CTX) -> SymbolStr {