Struct MarkdownReportWriter 

pub struct MarkdownReportWriter {
    pub section_dividers: bool,
}

Writes a SimulationReport as GitHub-flavored Markdown.

Usage:

use oxiphysics_io::simulation_report_io::{SimulationReport, MarkdownReportWriter};
let report = SimulationReport::new("My Simulation");
let md = MarkdownReportWriter::new().write(&report);
assert!(md.contains("# My Simulation"));

Fields

section_dividers: bool

Whether to add a horizontal rule between sections.

Implementations

impl MarkdownReportWriter

pub fn new() -> Self

Create a new writer with section dividers enabled.

pub fn write(&self, report: &SimulationReport) -> String

Render the report to a Markdown string.

Trait Implementations

impl Clone for MarkdownReportWriter

fn clone(&self) -> MarkdownReportWriter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownReportWriter

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

Formats the value using the given formatter.

impl Default for MarkdownReportWriter

fn default() -> MarkdownReportWriter

Returns the “default value” for a type.