Struct rustdoc::html::render::context::Context

pub(crate) struct Context<'tcx> {
    pub(crate) current: Vec<String>,
    pub(super) dst: PathBuf,
    pub(super) render_redirect_pages: bool,
    pub(super) id_map: RefCell<IdMap>,
    pub(super) deref_id_map: RefCell<FxHashMap<DefId, String>>,
    pub(super) shared: Rc<SharedContext<'tcx>>,
    pub(super) cache: Rc<Cache>,
}

Major driving force in all rustdoc rendering. This contains information about where in the tree-like hierarchy rendering is occurring and controls how the current page is being rendered.

It is intended that this context is a lightweight object which can be fairly easily cloned because it is cloned per work-job (about once per item in the rustdoc tree).

Fields

current: Vec<String>

Current hierarchy of components leading down to what’s currently being rendered

dst: PathBuf

The current destination folder of where HTML artifacts should be placed. This changes as the context descends into the module hierarchy.

render_redirect_pages: bool

A flag, which when true, will render pages which redirect to the real location of an item. This is used to allow external links to publicly reused items to redirect to the right location.

id_map: RefCell<IdMap>

The map used to ensure all generated ‘id=’ attributes are unique.

deref_id_map: RefCell<FxHashMap<DefId, String>>

Tracks section IDs for Deref targets so they match in both the main body and the sidebar.

shared: Rc<SharedContext<'tcx>>

Shared mutable state.

Issue for improving the situation: #82381

cache: Rc<Cache>

The Cache used during rendering.

Ideally the cache would be in SharedContext, but it’s mutated between when the SharedContext is created and when Context is created, so more refactoring would be needed.

It’s immutable once in Context, so it’s not as bad that it’s not in SharedContext.

Implementations

impl<'tcx> Context<'tcx>

pub(crate) fn tcx(&self) -> TyCtxt<'tcx>

pub(crate) fn cache(&self) -> &Cache

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

pub(super) fn derive_id(&self, id: String) -> String

pub(super) fn root_path(&self) -> String

String representation of how to get back to the root path of the ‘doc/’ folder in terms of a relative URL.

fn render_item(&self, it: &Item, is_module: bool) -> String

fn build_sidebar_items(
    &self,
    m: &Module
) -> BTreeMap<String, Vec<(String, Option<String>)>>

Construct a map of items shown in the sidebar to a plain-text summary of their docs.

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

Generates a url appropriate for an href attribute back to the source of this item.

The url generated, when clicked, will redirect the browser back to the original source code.

If None is returned, then a source link couldn’t be generated. This may happen, for example, with externally inlined items where the source of their crate documentation isn’t known.

impl Context<'_>

fn suffix_path(&self, filename: &str) -> PathBuf

fn write_shared<C: AsRef<[u8]>>(
    &self,
    resource: SharedResource<'_>,
    contents: C,
    emit: &[EmitType]
) -> Result<(), Error>

fn write_minify(
    &self,
    resource: SharedResource<'_>,
    contents: &str,
    minify: bool,
    emit: &[EmitType]
) -> Result<(), Error>

Trait Implementations

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

Generates the documentation for crate into the directory dst

fn descr() -> &'static str

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

const RUN_ON_MODULE: bool

Whether to call item recursivly 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 after_krate(&mut self) -> Result<(), Error>

Post processing hook for cleanup and dumping output to files.

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

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

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

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

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

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

fn cache(&self) -> &Cache