Trait rustdoc::formats::renderer::FormatRenderer

pub(crate) trait FormatRenderer<'tcx>: Sized {
    const RUN_ON_MODULE: bool;

    fn descr() -> &'static str;
    fn init(
        krate: Crate, 
        options: RenderOptions, 
        cache: Cache, 
        tcx: TyCtxt<'tcx>
    ) -> Result<(Self, Crate), Error>;
    fn make_child_renderer(&self) -> Self;
    fn item(&mut self, item: Item) -> Result<(), Error>;
    fn mod_item_in(&mut self, item: &Item) -> Result<(), Error>;
    fn after_krate(&mut self) -> Result<(), Error>;
    fn cache(&self) -> &Cache;

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

Allows for different backends to rustdoc to be used with the run_format() function. Each backend renderer has hooks for initialization, documenting an item, entering and exiting a module, and cleanup/finalizing output.

Associated Constants

const RUN_ON_MODULE: bool

Whether to call item recursivly for modules

This is true for html, and false for json. See #80664

Loading content...

Required methods

fn descr() -> &'static str

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

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 item(&mut self, item: Item) -> Result<(), Error>

Renders a single non-module item. This means no recursive sub-item rendering is required.

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

Loading content...

Provided methods

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

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

Loading content...

Implementors

impl<'tcx> FormatRenderer<'tcx> for Context<'tcx>

Generates the documentation for crate into the directory dst

fn descr() -> &'static str

const RUN_ON_MODULE: bool

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

fn make_child_renderer(&self) -> Self

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

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

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

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

fn cache(&self) -> &Cache

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

const RUN_ON_MODULE: bool

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

fn make_child_renderer(&self) -> Self

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

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

fn cache(&self) -> &Cache

Loading content...