rustdoc::html::highlight

Struct TokenHandler

Source
struct TokenHandler<'a, 'tcx, F: Write> {
    out: &'a mut F,
    closing_tags: Vec<(&'static str, Class)>,
    pending_exit_span: Option<Class>,
    current_class: Option<Class>,
    pending_elems: Vec<(&'a str, Option<Class>)>,
    href_context: Option<HrefContext<'a, 'tcx>>,
}
Expand description

This type is used as a conveniency to prevent having to pass all its fields as arguments into the various functions (which became its methods).

Fields§

§out: &'a mut F§closing_tags: Vec<(&'static str, Class)>

It contains the closing tag and the associated Class.

§pending_exit_span: Option<Class>

This is used because we don’t automatically generate the closing tag on ExitSpan in case an EnterSpan event with the same class follows.

§current_class: Option<Class>

current_class and pending_elems are used to group HTML elements with same class attributes to reduce the DOM size.

§pending_elems: Vec<(&'a str, Option<Class>)>

We need to keep the Class for each element because it could contain a Span which is used to generate links.

§href_context: Option<HrefContext<'a, 'tcx>>

Implementations§

Source§

impl<F: Write> TokenHandler<'_, '_, F>

Source

fn handle_exit_span(&mut self)

Source

fn write_pending_elems(&mut self, current_class: Option<Class>) -> bool

Write all the pending elements sharing a same (or at mergeable) Class.

If there is a “parent” (if a EnterSpan event was encountered) and the parent can be merged with the elements’ class, then we simply write the elements since the ExitSpan event will close the tag.

Otherwise, if there is only one pending element, we let the string function handle both opening and closing the tag, otherwise we do it into this function.

It returns true if current_class must be set to None afterwards.

Trait Implementations§

Source§

impl<F: Write> Drop for TokenHandler<'_, '_, F>

Source§

fn drop(&mut self)

When leaving, we need to flush all pending data to not have missing content.

Auto Trait Implementations§

§

impl<'a, 'tcx, F> Freeze for TokenHandler<'a, 'tcx, F>

§

impl<'a, 'tcx, F> !RefUnwindSafe for TokenHandler<'a, 'tcx, F>

§

impl<'a, 'tcx, F> !Send for TokenHandler<'a, 'tcx, F>

§

impl<'a, 'tcx, F> !Sync for TokenHandler<'a, 'tcx, F>

§

impl<'a, 'tcx, F> Unpin for TokenHandler<'a, 'tcx, F>

§

impl<'a, 'tcx, F> !UnwindSafe for TokenHandler<'a, 'tcx, F>

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