Struct rustdoc::html::render::Context [−] [src]

pub struct Context {
    pub current: Vec<String>,
    pub root_path: String,
    pub dst: PathBuf,
    pub render_redirect_pages: bool,
    pub shared: Arc<SharedContext>,
}
Unstable (rustdoc)

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>
Unstable (rustdoc)

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

root_path: String
Unstable (rustdoc)

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

dst: PathBuf
Unstable (rustdoc)

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
Unstable (rustdoc)

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.

shared: Arc<SharedContext>
Unstable (rustdoc)

Trait Implementations

Derived Implementations

impl Clone for Context
[src]

fn clone(&self) -> Context

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more