[][src]Struct struckdown::parser::Parser

pub struct Parser { /* fields omitted */ }

A configurable parser for struckdown.

Implementations

impl Parser[src]

pub fn new(options: &ParserOptions) -> Parser[src]

Creates a new parser with specific options.

pub fn parse<'data>(
    &self,
    s: &'data str
) -> impl Iterator<Item = AnnotatedEvent<'data>>
[src]

Parses structured cmark into an event stream.

The given structured cmark input will be parsed into a well formed event stream. Events are wrapped in the AnnotatedEvent struct which provides appropriate location information.

Note that even without any further processing not all events that come out of a markdown document will have a location information set. For instance tables produce a Tag::TableHeader and Tag::TableBody wrapper which does not exist as such in the source. Both of those will not have a location attached.

Trait Implementations

impl Default for Parser[src]

Auto Trait Implementations

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, 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.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,