rustdoc_processor 0.1.0

Compute, cache, index, and query rustdoc JSON documentation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! Core rustdoc data types.

mod item_index;
mod item_paths;

pub use item_index::{CrateItemIndex, EagerCrateItemIndex, LazyCrateItemIndex};
pub use item_paths::{CrateItemPaths, EagerCrateItemPaths, LazyCrateItemPaths};

use rustc_hash::FxHashMap;
use rustdoc_types::ExternalCrate;

/// The JSON documentation for a crate.
#[derive(Debug, Clone)]
pub struct CrateData {
    /// The id of the root item for the crate.
    pub root_item_id: rustdoc_types::Id,
    /// A mapping from the id of an external crate to the information about it.
    #[allow(clippy::disallowed_types)]
    pub external_crates: FxHashMap<u32, ExternalCrate>,
    /// A mapping from the id of a type to its fully qualified path.
    /// Primarily useful for foreign items that are being re-exported by this crate.
    pub paths: CrateItemPaths,
    /// The version of the JSON format used by rustdoc.
    pub format_version: u32,
    /// The index of all the items in the crate.
    pub index: CrateItemIndex,
}