Struct rustdoc::html::toc::TocBuilder
source · pub(crate) struct TocBuilder {
top_level: Toc,
chain: Vec<TocEntry>,
}
Expand description
Progressive construction of a table of contents.
Fields§
§top_level: Toc
§chain: Vec<TocEntry>
The current hierarchy of parent headings, the levels are
strictly increasing (i.e., chain[0].level < chain[1].level < ...
) with each entry being the most recent occurrence of a
heading with that level (it doesn’t include the most recent
occurrences of every level, just, if it is in chain
then
it is the most recent one).
We also have chain[0].level <= top_level.entries[last]
.
Implementations§
source§impl TocBuilder
impl TocBuilder
pub(crate) fn new() -> TocBuilder
sourcefn fold_until(&mut self, level: u32)
fn fold_until(&mut self, level: u32)
Collapse the chain until the first heading more important than
level
(i.e., lower level)
Example:
## A
# B
# C
## D
## E
### F
#### G
### H
If we are considering H (i.e., level 3), then A and B are in self.top_level, D is in C.children, and C, E, F, G are in self.chain.
When we attempt to push H, we realize that first G is not the parent (level is too high) so it is popped from chain and put into F.children, then F isn’t the parent (level is equal, aka sibling), so it’s also popped and put into E.children.
This leaves us looking at E, which does have a smaller level, and, by construction, it’s the most recent thing with smaller level, i.e., it’s the immediate parent of H.
Trait Implementations§
source§impl PartialEq<TocBuilder> for TocBuilder
impl PartialEq<TocBuilder> for TocBuilder
source§fn eq(&self, other: &TocBuilder) -> bool
fn eq(&self, other: &TocBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for TocBuilder
Auto Trait Implementations§
impl RefUnwindSafe for TocBuilder
impl Send for TocBuilder
impl Sync for TocBuilder
impl Unpin for TocBuilder
impl UnwindSafe for TocBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
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: 48 bytes