Struct MdDocument 

pub struct MdDocument<'input> { /* private fields */ }

A parsed version of a Markdown source.

The struct is opaque and encapsulates the result of parsing at the Markdown level. See the contents of [crate::spec] for extracting sections from an MdDocument instance.

Implementations

impl<'input> MdDocument<'input>

pub fn from_string(source: &'input str) -> Self

Create an MdDocument from a source string.

impl<'input> MdDocument<'input>

pub fn write_to_string(self) -> Result<String, Error>

Consume an MdDocument and write it back into a String.

pub fn write_to_path<P>(self, path: P) -> Result<(), Error>

where P: AsRef<Path>,

Consume an MdDocument and write it back into the given path.