[][src]Struct equt_md::Parser

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

Markdown event iterator.

Implementations

impl<'a> Parser<'a>[src]

pub fn new(text: &'a str) -> Parser<'a>[src]

Creates a new event iterator for a markdown string without any options enabled.

pub fn new_ext(text: &'a str, options: Options) -> Parser<'a>[src]

Creates a new event iterator for a markdown string with given options.

In case the parser encounters any potential links that have a broken reference (e.g [foo] when there is no [foo]: entry at the bottom) the provided callback will be called with the reference name, and the returned pair will be used as the link name and title if it is not None.

pub fn into_offset_iter(self) -> OffsetIter<'a>[src]

Consumes the event iterator and produces an iterator that produces (Event, Range) pairs, where the Range value maps to the corresponding range in the markdown source.

Trait Implementations

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

impl<'a> Iterator for Parser<'a>[src]

type Item = Event<'a>

The type of the elements being iterated over.

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Parser<'a>

impl<'a> !Send for Parser<'a>

impl<'a> !Sync for Parser<'a>

impl<'a> Unpin for Parser<'a>

impl<'a> !UnwindSafe for Parser<'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<I> IntoIterator for I where
    I: Iterator
[src]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

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.