Struct FormatterBuilder 

pub struct FormatterBuilder { /* private fields */ }

Builder for the MarkdownFormatter

Implementations

impl FormatterBuilder

pub fn with_config(config: Config) -> Self

Create a FormatterBuilder with custom Config.

let builder = FormatterBuilder::with_config(Config {
    max_width: Some(80),
    ..Default::default()
});
let formatter = builder.build();

pub fn with_code_block_formatter<F>(formatter: F) -> Self

where F: Fn(&str, String) -> String + 'static,

Create a FormatterBuilder with a custom code block formatter.

The closure used to reformat code blocks takes two arguments; the info string and the complete code snippet

let builder = FormatterBuilder::with_code_block_formatter(|info_string, code_block| {
    // Set the code block formatting logic
    match info_string.to_lowercase().as_str() {
        "rust" => {
            // format rust code
        }
        _ => code_block,
    }
});
let formatter = builder.build();

pub fn build(self) -> MarkdownFormatter

Build a MarkdownFormatter

let builder = FormatterBuilder::default();
let formatter: MarkdownFormatter = builder.build();

pub fn code_block_formatter<F>(&mut self, formatter: F) -> &mut Self

where F: Fn(&str, String) -> String + 'static,

Configure how code blocks should be reformatted after creating the FormatterBuilder.

The closure passed to code_block_formatter takes two arguments; the info string and the complete code snippet

pub fn max_width(&mut self, max_width: Option<usize>) -> &mut Self

Configure the max with when rewriting paragraphs.

When set to None, the deafault, paragraph width is left unchanged.

pub fn sichanghe_config(&mut self) -> &mut Self

Set the configuration based on Steven Hé (Sīchàng)’s opinion.

Trait Implementations

impl Debug for FormatterBuilder

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

Formats the value using the given formatter.

impl Default for FormatterBuilder

fn default() -> Self

Returns the “default value” for a type.