Struct FullItemId

pub(super) struct FullItemId {
    def_id: DefId,
    extra_id: Option<DefId>,
    name: Option<Symbol>,
}

An uninterned id.

Each one corresponds to exactly one of both:

1. rustdoc_json_types::Item.
2. rustdoc_json_types::Id transitively (as each Item has an Id).

It’s broadly equivalent to a DefId, but needs slightly more information to fully disambiguate items, because sometimes we choose to split a single HIR item into multiple JSON items, or have items with no corresponding HIR item.

Fields

def_id: DefId

The “main” id of the item.

In most cases this uniquely identifies the item, the other fields are just used for edge-cases.

extra_id: Option<DefId>

An extra DefId, which we need for:

1. Auto-trait impls synthesized by rustdoc.

2. Blanket impls synthesized by rustdoc.

3. Splitting of reexports of multiple items.

   E.g:

   mod module {
       pub struct Foo {} // Exists in type namespace
       pub fn Foo(){} // Exists in value namespace
   }
   
   pub use module::Foo; // Imports both items

   In HIR, the pub use is just 1 item, but in rustdoc-json it’s 2, so we need to disambiguate.

name: Option<Symbol>

Needed for #[rustc_doc_primitive] modules.

For these, 1 DefId is used for both the primitive and the fake-module that holds its docs.

N.B. This only matters when documenting the standard library with --document-private-items. Maybe we should delete that module, and remove this.

Trait Implementations

impl Clone for FullItemId

fn clone(&self) -> FullItemId

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FullItemId

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

Formats the value using the given formatter.

impl Hash for FullItemId

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 FullItemId

fn eq(&self, other: &FullItemId) -> 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 FullItemId

impl Eq for FullItemId

impl StructuralPartialEq for FullItemId

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 20 bytes