Struct rustdoc::json::JsonRenderer

pub(crate) struct JsonRenderer<'tcx> {
    tcx: TyCtxt<'tcx>,
    index: Rc<RefCell<FxHashMap<Id, Item>>>,
    out_dir: Option<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_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

Implementations

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

impl<'tcx> JsonRenderer<'tcx>

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

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

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

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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.

fn descr() -> &'static str

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

const RUN_ON_MODULE: bool = false

Whether to call item recursively for modules

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.

fn make_child_renderer(&self) -> Self

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

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

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

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

Post processing hook for cleanup and dumping output to files.

fn cache(&self) -> &Cache

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

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

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