[−][src]Struct pulldown_cmark_toc::Heading

pub struct Heading<'a> { /* fields omitted */ }

Represents a heading.

Implementations

impl<'_> Heading<'_>[src]

pub fn events(&self) -> Iter<Event>[src]

The raw events contained between the heading tags.

pub fn level(&self) -> &u32[src]

The heading level.

pub fn text(&self) -> String[src]

The heading text with all Markdown code stripped out.

The output of this this function can be used to generate an anchor.

pub fn anchor(&self) -> String[src]

Generate an anchor link for this heading.

This is calculated in the same way that GitHub calculates it.

Trait Implementations

impl<'a> Clone for Heading<'a>[src]

impl<'a> Debug for Heading<'a>[src]

Auto Trait Implementations

impl<'a> RefUnwindSafe for Heading<'a>

impl<'a> Send for Heading<'a>

impl<'a> Sync for Heading<'a>

impl<'a> Unpin for Heading<'a>

impl<'a> UnwindSafe for Heading<'a>

Blanket Implementations

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

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.