rustdoc::json

Struct JsonRenderer

source
pub(crate) struct JsonRenderer<'tcx> {
    tcx: TyCtxt<'tcx>,
    index: Rc<RefCell<FxHashMap<Id, Item>>>,
    out_dir: Option<PathBuf>,
    cache: Rc<Cache>,
    imported_items: DefIdSet,
    id_interner: Rc<RefCell<FxHashMap<(FullItemId, Option<FullItemId>), Id>>>,
}

Fields§

§tcx: TyCtxt<'tcx>§index: Rc<RefCell<FxHashMap<Id, Item>>>

A mapping of IDs that contains all local items for this crate which gets output as a top level field of the JSON blob.

§out_dir: Option<PathBuf>

The directory where the JSON blob should be written to.

If this is None, the blob will be printed to stdout instead.

§cache: Rc<Cache>§imported_items: DefIdSet§id_interner: Rc<RefCell<FxHashMap<(FullItemId, Option<FullItemId>), Id>>>

Implementations§

source§

impl JsonRenderer<'_>

source

pub(super) fn convert_item(&self, item: Item) -> Option<Item>

source

fn convert_span(&self, span: Span) -> Option<Span>

source

fn convert_visibility(&self, v: Option<Visibility<DefId>>) -> Visibility

source

pub(crate) fn id_from_item_default(&self, item_id: ItemId) -> Id

source

pub(crate) fn id_from_item_inner( &self, item_id: ItemId, name: Option<Symbol>, extra: Option<Id>, ) -> Id

source

pub(crate) fn id_from_item(&self, item: &Item) -> Id

source

fn ids(&self, items: impl IntoIterator<Item = Item>) -> Vec<Id>

source

fn ids_keeping_stripped( &self, items: impl IntoIterator<Item = Item>, ) -> Vec<Option<Id>>

source§

impl<'tcx> JsonRenderer<'tcx>

source

fn sess(&self) -> &'tcx Session

source

fn get_trait_implementors(&mut self, id: DefId) -> Vec<Id>

source

fn get_impls(&mut self, id: DefId) -> Vec<Id>

source

fn serialize_and_write<T: Write>( &self, output_crate: Crate, writer: BufWriter<T>, path: &str, ) -> Result<(), Error>

Trait Implementations§

source§

impl<'tcx> Clone for JsonRenderer<'tcx>

source§

fn clone(&self) -> JsonRenderer<'tcx>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx>

source§

fn item(&mut self, item: Item) -> Result<(), Error>

Inserts an item into the index. This should be used rather than directly calling insert on the hashmap because certain items (traits and types) need to have their mappings for trait implementations filled out before they’re inserted.

source§

const RUN_ON_MODULE: bool = false

Whether to call item recursively for modules Read more
source§

fn descr() -> &'static str

Gives a description of the renderer. Used for performance profiling.
source§

fn init( krate: Crate, options: RenderOptions, cache: Cache, tcx: TyCtxt<'tcx>, ) -> Result<(Self, Crate), Error>

Sets up any state required for the renderer. When this is called the cache has already been populated.
source§

fn make_child_renderer(&self) -> Self

Make a new renderer to render a child of the item currently being rendered.
source§

fn mod_item_in(&mut self, _item: &Item) -> Result<(), Error>

Renders a module (should not handle recursing into children).
source§

fn after_krate(&mut self) -> Result<(), Error>

Post processing hook for cleanup and dumping output to files.
source§

fn cache(&self) -> &Cache

source§

fn mod_item_out(&mut self) -> Result<(), Error>

Runs after recursively rendering all sub-items of a module.

Auto Trait Implementations§

§

impl<'tcx> Freeze for JsonRenderer<'tcx>

§

impl<'tcx> !RefUnwindSafe for JsonRenderer<'tcx>

§

impl<'tcx> !Send for JsonRenderer<'tcx>

§

impl<'tcx> !Sync for JsonRenderer<'tcx>

§

impl<'tcx> Unpin for JsonRenderer<'tcx>

§

impl<'tcx> !UnwindSafe for JsonRenderer<'tcx>

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, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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: 88 bytes