rustdoc::html::sources

Struct SourceCollector

source
struct SourceCollector<'a, 'tcx> {
    cx: &'a mut Context<'tcx>,
    dst: PathBuf,
    emitted_local_sources: FxHashSet<PathBuf>,
    crate_name: &'a str,
}
Expand description

Helper struct to render all source code to HTML pages

Fields§

§cx: &'a mut Context<'tcx>§dst: PathBuf

Root destination to place all HTML output into

§emitted_local_sources: FxHashSet<PathBuf>§crate_name: &'a str

Implementations§

source§

impl SourceCollector<'_, '_>

source

fn emit_source( &mut self, filename: &FileName, file_span: Span, ) -> Result<(), Error>

Renders the given filename into its corresponding HTML source file.

Trait Implementations§

source§

impl DocVisitor<'_> for SourceCollector<'_, '_>

source§

fn visit_item(&mut self, item: &Item)

source§

fn visit_inner_recur(&mut self, kind: &'a ItemKind)

Don’t override!
source§

fn visit_item_recur(&mut self, item: &'a Item)

Don’t override!
source§

fn visit_mod(&mut self, m: &'a Module)

source§

fn visit_crate(&mut self, c: &'a Crate)

This is the main entrypoint of DocVisitor.

Auto Trait Implementations§

§

impl<'a, 'tcx> Freeze for SourceCollector<'a, 'tcx>

§

impl<'a, 'tcx> !RefUnwindSafe for SourceCollector<'a, 'tcx>

§

impl<'a, 'tcx> !Send for SourceCollector<'a, 'tcx>

§

impl<'a, 'tcx> !Sync for SourceCollector<'a, 'tcx>

§

impl<'a, 'tcx> Unpin for SourceCollector<'a, 'tcx>

§

impl<'a, 'tcx> !UnwindSafe for SourceCollector<'a, 'tcx>

Blanket Implementations§

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> 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, 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<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

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

source§

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>,

source§

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

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