Struct DocContext

pub(crate) struct DocContext<'tcx> {

    pub(crate) tcx: TyCtxt<'tcx>,
    pub(crate) param_env: ParamEnv<'tcx>,
    pub(crate) external_traits: FxIndexMap<DefId, Trait>,
    pub(crate) active_extern_traits: DefIdSet,
    pub(crate) args: DefIdMap<GenericArg>,
    pub(crate) current_type_aliases: DefIdMap<usize>,
    pub(crate) impl_trait_bounds: FxHashMap<ImplTraitParam, Vec<GenericBound>>,
    pub(crate) generated_synthetics: FxHashSet<(Ty<'tcx>, DefId)>,
    pub(crate) auto_traits: Vec<DefId>,
    pub(crate) render_options: RenderOptions,
    pub(crate) cache: Cache,
    pub(crate) inlined: FxHashSet<ItemId>,
    pub(crate) output_format: OutputFormat,
    pub(crate) show_coverage: bool,
}

Fields

tcx: TyCtxt<'tcx>

param_env: ParamEnv<'tcx>

Used for normalization.

Most of this logic is copied from rustc_lint::late.

external_traits: FxIndexMap<DefId, Trait>

Later on moved through clean::Crate into cache

active_extern_traits: DefIdSet

Used while populating external_traits to ensure we don’t process the same trait twice at the same time.

args: DefIdMap<GenericArg>

The current set of parameter instantiations for expanding type aliases at the HIR level.

Maps from the DefId of a lifetime or type parameter to the generic argument it’s currently instantiated to in this context.

current_type_aliases: DefIdMap<usize>

impl_trait_bounds: FxHashMap<ImplTraitParam, Vec<GenericBound>>

Table synthetic type parameter for impl Trait in argument position -> bounds

generated_synthetics: FxHashSet<(Ty<'tcx>, DefId)>

Auto-trait or blanket impls processed so far, as (self_ty, trait_def_id).

auto_traits: Vec<DefId>

render_options: RenderOptions

The options given to rustdoc that could be relevant to a pass.

cache: Cache

This same cache is used throughout rustdoc, including in crate::html::render.

inlined: FxHashSet<ItemId>

Used by clean::inline to tell if an item has already been inlined.

output_format: OutputFormat

Used by calculate_doc_coverage.

show_coverage: bool

Used by strip_private.

Implementations

impl<'tcx> DocContext<'tcx>

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

pub(crate) fn with_param_env<T, F: FnOnce(&mut Self) -> T>( &mut self, def_id: DefId, f: F, ) -> T

pub(crate) fn enter_alias<F, R>( &mut self, args: DefIdMap<GenericArg>, def_id: DefId, f: F, ) -> R

where F: FnOnce(&mut Self) -> R,

Call the closure with the given parameters set as the generic parameters for a type alias’ RHS.

pub(crate) fn as_local_hir_id(tcx: TyCtxt<'_>, item_id: ItemId) -> Option<HirId>

Like tcx.local_def_id_to_hir_id(), but skips calling it on fake DefIds. (This avoids a slice-index-out-of-bounds panic.)

pub(crate) fn is_json_output(&self) -> bool

Returns true if the JSON output format is enabled for generating the crate content.

If another option like --show-coverage is enabled, it will return false.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1528 bytes