Struct hoedown::Markdown

pub struct Markdown {
    pub contents: Buffer,
    pub extensions: Extension,
    pub max_nesting: usize,
}

Markdown document

Fields

contents: Buffer

extensions: Extension

max_nesting: usize

Methods

impl Markdown

fn new(body: &str) -> Markdown

fn read_from<R>(reader: R) -> Markdown where
    R: Read, 

Construct a markdown document from a given Reader

By default it enables no Hoedown extensions and sets the maximum block depth to parse at 16. This may be changed with the with_extensions and with_max_nesting builder methods.

Note that Buffer also implements Reader, so it can be used with this method.

fn extensions(self, extensions: Extension) -> Markdown

Builder method to specify Hoedown extensions

fn max_nesting(self, max_nesting: usize) -> Markdown

Builder method to specify the maximum block depth to parse

Trait Implementations

impl Clone for Markdown

fn clone(&self) -> Markdown

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<Buffer> for Markdown

fn from(buffer: Buffer) -> Markdown

Performs the conversion.

impl<'a> From<&'a [u8]> for Markdown

fn from(bytes: &[u8]) -> Markdown

Performs the conversion.