[][src]Struct rustdoc::html::render::SharedContext

struct SharedContext {
    pub src_root: PathBuf,
    pub layout: Layout,
    pub include_sources: bool,
    pub local_sources: FxHashMap<PathBuf, String>,
    pub passes: FxHashSet<String>,
    pub issue_tracker_base_url: Option<String>,
    pub css_file_extension: Option<PathBuf>,
    pub created_dirs: RefCell<FxHashSet<PathBuf>>,
    pub sort_modules_alphabetically: bool,
    pub themes: Vec<PathBuf>,
    pub resource_suffix: String,
}

Fields

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

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

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.

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

All the passes that were run on this crate.

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

The given user css file which allow to customize the generated documentation theme.

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

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).

Additional themes to be added to the generated docs.

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

Methods

impl SharedContext
[src]

impl SharedContext
[src]

Returns whether the collapse-docs pass was run on this crate.

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

Auto Trait Implementations

impl Send for SharedContext

impl !Sync for SharedContext

Blanket Implementations

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Important traits for &'a mut R

Immutably borrows from an owned value. Read more

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Important traits for &'a mut R

Mutably borrows from an owned value. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

impl<E> SpecializationError for E
[src]

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Create an error for a missing method specialization. Defaults to panicking with type, trait & method names. S is the encoder/decoder state type, T is the type being encoded/decoded, and the arguments are the names of the trait and method that should've been overridden. Read more

impl<T> Erased for T
[src]

impl<T> Send for T where
    T: ?Sized
[src]

impl<T> Sync for T where
    T: ?Sized
[src]

impl<T> Erased for T

impl<T> MaybeResult for T
[src]

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl<'a, T> Captures for T where
    T: ?Sized
[src]