Struct Crate

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 target: Target,
    pub format_version: u32,
}

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.

target: Target

Information about the target for which this documentation was generated

format_version: u32

A single version number to be used in the future when making backwards incompatible changes to the JSON output.

Trait Implementations

impl Clone for Crate

fn clone(&self) -> Crate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Crate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Crate

fn deserialize<__D>( __deserializer: __D, ) -> Result<Crate, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Crate

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Crate

impl StructuralPartialEq for Crate