Crate in rustdoc_json_types - Rust
Description: The root of the emitted JSON blob.

Skip to main content

## Crate

# Struct Crate

Source

    pub struct Crate {
        pub root: Id,
        pub crate_version: Option<String>,
        pub includes_private: bool,
        pub index: FxHashMap<Id, Item>,
        pub paths: FxHashMap<Id, ItemSummary>,
        pub external_crates: FxHashMap<u32, ExternalCrate>,
        pub target: Target,
        pub format_version: u32,
    }

Expand description

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: FxHashMap<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: FxHashMap<Id, ItemSummary>`

Maps IDs to fully qualified paths and other info helpful for generating links.

§`external_crates: FxHashMap<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§

Source§

### impl Clone for Crate

Source§

#### fn clone(&self) -> Crate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for Crate

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

### impl PartialEq for Crate

Source§

#### fn eq(&self, other: &Crate) -> bool

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 (const: unstable) · Source§

#### fn ne(&self, other: &Rhs) -> bool

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

### impl Serialize for Crate

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

### impl Eq for Crate

Source§

### impl StructuralPartialEq for Crate

## Auto Trait Implementations§

§

### impl Freeze for Crate

§

### impl RefUnwindSafe for Crate

§

### impl Send for Crate

§

### impl Sync for Crate

§

### impl Unpin for Crate

§

### impl UnsafeUnpin for Crate

§

### impl UnwindSafe for Crate

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

## 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: 184 bytes