Struct rustdoc::core::DocContext

source ·
pub(crate) struct DocContext<'tcx> {
Show 14 fields pub(crate) tcx: TyCtxt<'tcx>, pub(crate) param_env: ParamEnv<'tcx>, pub(crate) external_traits: Rc<RefCell<FxHashMap<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: Rc<RefCell<FxHashMap<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§

source§

impl<'tcx> DocContext<'tcx>

source

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

source

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

source

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.

source

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

Auto Trait Implementations§

§

impl<'tcx> !DynSend for DocContext<'tcx>

§

impl<'tcx> !DynSync for DocContext<'tcx>

§

impl<'tcx> !RefUnwindSafe for DocContext<'tcx>

§

impl<'tcx> !Send for DocContext<'tcx>

§

impl<'tcx> !Sync for DocContext<'tcx>

§

impl<'tcx> Unpin for DocContext<'tcx>

§

impl<'tcx> !UnwindSafe for DocContext<'tcx>

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = _

Alignment of Self.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, R> CollectAndApply<T, R> for T

source§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

§

type Output = R

§

impl<T> Filterable for T

§

fn filterable( self, filter_name: &'static str ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<P> IntoQueryParam<P> for P

source§

impl<T> MaybeResult<T> for T

§

type Error = !

source§

fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

source§

fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<'tcx, T> ToPredicate<'tcx, T> for T

source§

fn to_predicate(self, _tcx: TyCtxt<'tcx>) -> T

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<Tcx, T> Value<Tcx> for T
where Tcx: DepContext,

source§

default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed ) -> T

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

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

source§

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

§

impl<T> ErasedDestructor for T
where T: 'static,

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: 1264 bytes