Struct MarkdownFormatter 

pub struct MarkdownFormatter { /* private fields */ }

Formats validation results as Markdown suitable for documentation.

This formatter creates Markdown output that can be included in reports, documentation, or README files. It provides a clean, structured format with proper heading hierarchy.

Examples

use term_guard::formatters::{ResultFormatter, MarkdownFormatter};

let formatter = MarkdownFormatter::new();
let markdown_output = formatter.format(&result).unwrap();
println!("{}", markdown_output);

Implementations

impl MarkdownFormatter

pub fn new() -> Self

Creates a new Markdown formatter with default configuration.

pub fn with_config(config: FormatterConfig) -> Self

Creates a new Markdown formatter with the specified configuration.

pub fn with_heading_level(self, level: u8) -> Self

Sets the base heading level for the output.

Trait Implementations

impl Clone for MarkdownFormatter

fn clone(&self) -> MarkdownFormatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownFormatter

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

Formats the value using the given formatter.

impl Default for MarkdownFormatter

fn default() -> Self

Returns the “default value” for a type.

impl ResultFormatter for MarkdownFormatter

fn format(&self, result: &ValidationResult) -> Result<String>

Formats a validation result into a string representation.

fn format_with_config( &self, result: &ValidationResult, config: &FormatterConfig, ) -> Result<String>

Formats a validation result with custom configuration.