bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Improve lang item generated docs

Browse source 
cc https://rust-lang.zulipchat.com/#narrow/stream/146229-wg-secure-code/topic/Is.20.60core.60.20part.20of.20the.20compiler.3F/near/226738260
This commit is contained in:
Camelid 2021-02-19 14:13:25 -08:00
parent 9b471a3f5f
commit e5f1e8883a
1 changed files with 16 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

26
compiler/rustc_hir/src/lang_items.rs
View file

@ -45,20 +45,25 @@ macro_rules! language_item_table {
/// A representation of all the valid language items in Rust. /// A representation of all the valid language items in Rust.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Encodable, Decodable)] #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Encodable, Decodable)]
pub enum LangItem { pub enum LangItem {
$($variant,)* $(
#[doc = concat!("The `", stringify!($name), "` lang item.")]
$variant,
)*
} }
} }
impl LangItem { impl LangItem {
/// Returns the `name` symbol in `#[lang = "$name"]`. /// Returns the `name` symbol in `#[lang = "$name"]`.
/// For example, `LangItem::EqTraitLangItem`, /// For example, [`LangItem::PartialEq`]`.name()`
/// that is `#[lang = "eq"]` would result in `sym::eq`. /// would result in [`sym::eq`] since it is `#[lang = "eq"]`.
pub fn name(self) -> Symbol { pub fn name(self) -> Symbol {
match self { match self {
$( LangItem::$variant => $name, )* $( LangItem::$variant => $name, )*
} }
} }
/// The [group](LangItemGroup) that this lang item belongs to,
/// or `None` if it doesn't belong to a group.
pub fn group(self) -> Option<LangItemGroup> { pub fn group(self) -> Option<LangItemGroup> {
use LangItemGroup::*; use LangItemGroup::*;
match self { match self {
@ -67,15 +72,16 @@ macro_rules! language_item_table {
} }
} }
/// All of the language items in the current crate, defined or not.
#[derive(HashStable_Generic, Debug)] #[derive(HashStable_Generic, Debug)]
pub struct LanguageItems { pub struct LanguageItems {
/// Mappings from lang items to their possibly found `DefId`s. /// Mappings from lang items to their possibly found [`DefId`]s.
/// The index corresponds to the order in `LangItem`. /// The index corresponds to the order in [`LangItem`].
pub items: Vec<Option<DefId>>, pub items: Vec<Option<DefId>>,
/// Lang items that were not found during collection. /// Lang items that were not found during collection.
pub missing: Vec<LangItem>, pub missing: Vec<LangItem>,
/// Mapping from `LangItemGroup` discriminants to all /// Mapping from [`LangItemGroup`] discriminants to all
/// `DefId`s of lang items in that group. /// [`DefId`]s of lang items in that group.
pub groups: [Vec<DefId>; NUM_GROUPS], pub groups: [Vec<DefId>; NUM_GROUPS],
} }
@ -103,13 +109,13 @@ macro_rules! language_item_table {
self.items[it as usize].ok_or_else(|| format!("requires `{}` lang_item", it.name())) self.items[it as usize].ok_or_else(|| format!("requires `{}` lang_item", it.name()))
} }
/// Returns the [`DefId`]s of all lang items in a group.
pub fn group(&self, group: LangItemGroup) -> &[DefId] { pub fn group(&self, group: LangItemGroup) -> &[DefId] {
self.groups[group as usize].as_ref() self.groups[group as usize].as_ref()
} }
$( $(
/// Returns the corresponding `DefId` for the lang item if it #[doc = concat!("Returns the [`DefId`] of the `", stringify!($name), "` lang item if it is defined.")]
/// exists.
#[allow(dead_code)] #[allow(dead_code)]
pub fn $method(&self) -> Option<DefId> { pub fn $method(&self) -> Option<DefId> {
self.items[LangItem::$variant as usize] self.items[LangItem::$variant as usize]
@ -140,7 +146,7 @@ impl<CTX> HashStable<CTX> for LangItem {
/// ///
/// About the `check_name` argument: passing in a `Session` would be simpler, /// About the `check_name` argument: passing in a `Session` would be simpler,
/// because then we could call `Session::check_name` directly. But we want to /// because then we could call `Session::check_name` directly. But we want to
/// avoid the need for `librustc_hir` to depend on `librustc_session`, so we /// avoid the need for `rustc_hir` to depend on `rustc_session`, so we
/// use a closure instead. /// use a closure instead.
pub fn extract<'a, F>(check_name: F, attrs: &'a [ast::Attribute]) -> Option<(Symbol, Span)> pub fn extract<'a, F>(check_name: F, attrs: &'a [ast::Attribute]) -> Option<(Symbol, Span)>
where where