Struct rustdoc::json::JsonRenderer

pub(crate) struct JsonRenderer<'tcx> {
    tcx: TyCtxt<'tcx>,
    index: Rc<RefCell<FxHashMap<Id, Item>>>,
    out_path: PathBuf,
}

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.

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: Visibility) -> Visibility

impl JsonRenderer<'_>

fn sess(&self) -> &Session

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

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

fn get_trait_items(&mut self, cache: &Cache) -> Vec<(Id, Item)>

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

pub(crate) fn init(
    krate: Crate,
    options: RenderOptions,
    _render_info: RenderInfo,
    _edition: Edition,
    _cache: &mut 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.

pub(crate) fn item(&mut self, item: Item, cache: &Cache) -> 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.

pub(crate) fn mod_item_in(
    &mut self,
    item: &Item,
    _module_name: &str,
    cache: &Cache
) -> Result<(), Error>

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

pub(crate) fn mod_item_out(&mut self, _item_name: &str) -> Result<(), Error>

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

pub(crate) fn after_krate(
    &mut self,
    krate: &Crate,
    cache: &Cache
) -> Result<(), Error>

Post processing hook for cleanup and dumping output to files.

pub(crate) fn after_run(&mut self, _diag: &Handler) -> Result<(), Error>

Called after everything else to write out errors.