Struct rustdoc_types::Crate
source · [−]pub struct Crate {
pub root: Id,
pub crate_version: Option<String>,
pub includes_private: bool,
pub index: HashMap<Id, Item>,
pub paths: HashMap<Id, ItemSummary>,
pub external_crates: HashMap<u32, ExternalCrate>,
pub format_version: u32,
}
Expand description
A Crate
is the root of the emitted JSON blob. It contains all type/documentation information
about the language items in the local crate, as well as info about external items to allow
tools to find or link to them.
Fields
root: Id
The id of the root Module
item of the local crate.
crate_version: Option<String>
The version string given to --crate-version
, if any.
includes_private: bool
Whether or not the output includes private items.
index: HashMap<Id, Item>
A collection of all items in the local crate as well as some external traits and their items that are referenced locally.
paths: HashMap<Id, ItemSummary>
Maps IDs to fully qualified paths and other info helpful for generating links.
external_crates: HashMap<u32, ExternalCrate>
Maps crate_id
of items to a crate name and html_root_url if it exists.
format_version: u32
A single version number to be used in the future when making backwards incompatible changes to the JSON output.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Crate
impl<'de> Deserialize<'de> for Crate
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl StructuralPartialEq for Crate
Auto Trait Implementations
impl RefUnwindSafe for Crate
impl Send for Crate
impl Sync for Crate
impl Unpin for Crate
impl UnwindSafe for Crate
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more