[−][src]Struct rustdoc::html::toc::TocBuilder
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]
.
Methods
impl TocBuilder
[src]
impl TocBuilder
pub fn new() -> TocBuilder
[src]
pub fn new() -> TocBuilder
pub fn into_toc(self) -> Toc
[src]
pub fn into_toc(self) -> Toc
Convert into a true Toc
struct.
fn fold_until(&mut self, level: u32)
[src]
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.
pub fn push<'a>(&'a mut self, level: u32, name: String, id: String) -> &'a str
[src]
pub fn push<'a>(&'a mut self, level: u32, name: String, id: String) -> &'a str
Push a level level
heading into the appropriate place in the
hierarchy, returning a string containing the section number in
<num>.<num>.<num>
format.
Trait Implementations
impl PartialEq for TocBuilder
[src]
impl PartialEq for TocBuilder
fn eq(&self, other: &TocBuilder) -> bool
[src]
fn eq(&self, other: &TocBuilder) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &TocBuilder) -> bool
[src]
fn ne(&self, other: &TocBuilder) -> bool
This method tests for !=
.
Auto Trait Implementations
impl Send for TocBuilder
impl Send for TocBuilder
impl Sync for TocBuilder
impl Sync for TocBuilder
Blanket Implementations
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
ⓘImportant traits for &'a mut Rfn borrow(&self) -> &T
[src]
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
try_from
)Performs the conversion.
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
ⓘImportant traits for &'a mut Rfn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<E> SpecializationError for E
[src]
impl<E> SpecializationError for E
fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where
T: ?Sized,
[src]
fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where
T: ?Sized,
🔬 This is a nightly-only experimental API. (rustc_private
)
this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml
instead?
Create an error for a missing method specialization. Defaults to panicking with type, trait & method names. S
is the encoder/decoder state type, T
is the type being encoded/decoded, and the arguments are the names of the trait and method that should've been overridden. Read more
impl<T> Erased for T
[src]
impl<T> Erased for T
impl<T> Send for T where
T: ?Sized,
[src]
impl<T> Send for T where
T: ?Sized,
impl<T> Sync for T where
T: ?Sized,
[src]
impl<T> Sync for T where
T: ?Sized,
impl<T> Erased for T
impl<T> Erased for T
impl<T> MaybeResult for T
[src]
impl<T> MaybeResult for T
fn from_ok(x: T) -> T
[src]
fn from_ok(x: T) -> T
🔬 This is a nightly-only experimental API. (rustc_private
)
this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml
instead?
fn map_same<F>(self, f: F) -> T where
F: FnOnce(T) -> T,
[src]
fn map_same<F>(self, f: F) -> T where
F: FnOnce(T) -> T,
🔬 This is a nightly-only experimental API. (rustc_private
)
this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml
instead?
impl<'a, T> Captures for T where
T: ?Sized,
[src]
impl<'a, T> Captures for T where
T: ?Sized,