Struct rustdoc_types::ItemSummary

pub struct ItemSummary {
    pub crate_id: u32,
    pub path: Vec<String>,
    pub kind: ItemKind,
}

For external (not defined in the local crate) items, you don't get the same level of information. This struct should contain enough to generate a link/reference to the item in question, or can be used by a tool that takes the json output of multiple crates to find the actual item definition with all the relevant info.

Fields

crate_id: u32

Can be used to look up the name and html_root_url of the crate this item came from in the external_crates map.

path: Vec<String>

The list of path components for the fully qualified path of this item (e.g. ["std", "io", "lazy", "Lazy"] for std::io::lazy::Lazy).

kind: ItemKind

Whether this item is a struct, trait, macro, etc.

Trait Implementations

impl Clone for ItemSummary

pub fn clone(&self) -> ItemSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ItemSummary

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<ItemSummary> for ItemSummary

pub fn eq(&self, other: &ItemSummary) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &ItemSummary) -> bool

This method tests for !=.

impl Serialize for ItemSummary

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ItemSummary