Struct rustdoc::html::render::SharedContext

pub(crate) struct SharedContext<'tcx> {
    pub(crate) tcx: TyCtxt<'tcx>,
    pub(crate) src_root: PathBuf,
    pub(crate) layout: Layout,
    pub(crate) include_sources: bool,
    pub(crate) local_sources: FxHashMap<PathBuf, String>,
    collapsed: bool,
    issue_tracker_base_url: Option<String>,
    created_dirs: RefCell<FxHashSet<PathBuf>>,
    sort_modules_alphabetically: bool,
    pub(crate) style_files: Vec<StylePath>,
    pub(crate) resource_suffix: String,
    pub(crate) static_root_path: Option<String>,
    pub(crate) fs: DocFS,
    pub(crate) edition: Edition,
    codes: ErrorCodes,
    playground: Option<Playground>,
    all: RefCell<AllTypes>,
    errors: Receiver<String>,
    redirections: Option<RefCell<FxHashMap<String, String>>>,
}

Shared mutable state used in Context and elsewhere.

Fields

tcx: TyCtxt<'tcx>

src_root: PathBuf

The path to the crate root source minus the file name. Used for simplifying paths to the highlighted source code files.

layout: Layout

This describes the layout of each page, and is not modified after creation of the context (contains info like the favicon and added html).

include_sources: bool

This flag indicates whether [src] links should be generated or not. If the source files are present in the html rendering, then this will be true.

local_sources: FxHashMap<PathBuf, String>

The local file sources we’ve emitted and their respective url-paths.

collapsed: bool

Whether the collapsed pass ran

issue_tracker_base_url: Option<String>

The base-URL of the issue tracker for when an item has been tagged with an issue number.

created_dirs: RefCell<FxHashSet<PathBuf>>

The directories that have already been created in this doc run. Used to reduce the number of spurious create_dir_all calls.

sort_modules_alphabetically: bool

This flag indicates whether listings of modules (in the side bar and documentation itself) should be ordered alphabetically or in order of appearance (in the source code).

style_files: Vec<StylePath>

Additional CSS files to be added to the generated docs.

resource_suffix: String

Suffix to be added on resource files (if suffix is “-v2” then “light.css” becomes “light-v2.css”).

static_root_path: Option<String>

Optional path string to be used to load static files on output pages. If not set, uses combinations of ../ to reach the documentation root.

fs: DocFS

The fs handle we are working with.

edition: Edition

The default edition used to parse doctests.

codes: ErrorCodes

playground: Option<Playground>

all: RefCell<AllTypes>

errors: Receiver<String>

Storage for the errors produced while generating documentation so they can be printed together at the end.

redirections: Option<RefCell<FxHashMap<String, String>>>

None by default, depends on the generate-redirect-map option flag. If this field is set to Some(...), it’ll store redirections and then generate a JSON file at the top level of the crate.

Implementations

impl SharedContext<'_>

pub(crate) fn ensure_dir(&self, dst: &Path) -> Result<(), Error>

pub(crate) fn maybe_collapsed_doc_value<'a>(
    &self,
    item: &'a Item
) -> Option<String>

Based on whether the collapse-docs pass was run, return either the doc_value or the collapsed_doc_value of the given item.