Struct cmarkfmt::Formatter

pub struct Formatter<'a> { /* private fields */ }

A Formatter is needed to format markdown. It is created and customized as needed using the with_* methods.

Once created, the format_cmark or format_cmark_writer methods can be used.

Implementations

impl<'a> Formatter<'a>

pub fn format_cmark(&self, input: &str) -> String

Format markdown, returning the formatted result as a String.

pub fn format_cmark_writer<W: Write>(&self, input: &str, w: W) -> Result

Format markdown, writing the result to the provided Writer.

pub fn with_code_formatter(self, code_fmt: Option<CodeFormatFn<'a>>) -> Self

Sets the Formatters code formatter function. By default, code blocks are not formatted.

pub fn with_blockquote(self, blockquote: &'a str) -> Self

Sets the blockquote string. Default: “>”.

pub fn with_emphasis(self, emphasis: &'a str) -> Self

Sets the emphasis string. Default: “_”.

pub fn with_unordered_list(self, unordered_list: &'a str) -> Self

Sets the unordered list string. Default: “-”.

Trait Implementations

impl<'a> Clone for Formatter<'a>

fn clone(&self) -> Formatter<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Formatter<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Formatter<'_>

fn default() -> Self

Returns the “default value” for a type.