Struct rustdoc::json::JsonRenderer
source · pub(crate) struct JsonRenderer<'tcx> {
tcx: TyCtxt<'tcx>,
index: Rc<RefCell<FxHashMap<Id, Item>>>,
out_path: PathBuf,
cache: Rc<Cache>,
imported_items: DefIdSet,
}
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_path: PathBuf
The directory where the blob will be written to.
cache: Rc<Cache>
§imported_items: DefIdSet
Implementations§
source§impl JsonRenderer<'_>
impl JsonRenderer<'_>
pub(super) fn convert_item(&self, item: Item) -> Option<Item>
fn convert_span(&self, span: Span) -> Option<Span>
fn convert_visibility(&self, v: Option<Visibility<DefId>>) -> Visibility
Trait Implementations§
source§impl<'tcx> Clone for JsonRenderer<'tcx>
impl<'tcx> Clone for JsonRenderer<'tcx>
source§fn clone(&self) -> JsonRenderer<'tcx>
fn clone(&self) -> JsonRenderer<'tcx>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx>
impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx>
source§fn item(&mut self, item: Item) -> Result<(), Error>
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§fn descr() -> &'static str
fn descr() -> &'static str
Gives a description of the renderer. Used for performance profiling.
source§const RUN_ON_MODULE: bool = false
const RUN_ON_MODULE: bool = false
Whether to call
item
recursively for modules Read moresource§fn init(
krate: Crate,
options: RenderOptions,
cache: Cache,
tcx: TyCtxt<'tcx>
) -> Result<(Self, Crate), Error>
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
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>
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>
fn after_krate(&mut self) -> Result<(), Error>
Post processing hook for cleanup and dumping output to files.
fn cache(&self) -> &Cache
Auto Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
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: 80 bytes