Struct ReportBuilder 

pub struct ReportBuilder { /* private fields */ }

Fluent builder for constructing a SimulationReport and immediately rendering it to a target format.

Implementations

impl ReportBuilder

pub fn new(title: impl Into<String>) -> Self

Create a new builder.

pub fn author(self, author: impl Into<String>) -> Self

Set the author.

pub fn date(self, date: impl Into<String>) -> Self

Set the date.

pub fn description(self, desc: impl Into<String>) -> Self

Set the description.

pub fn parameter(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a parameter.

pub fn result(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a result metric.

pub fn section(self, section: ReportSection) -> Self

Add a section.

pub fn build(self) -> SimulationReport

Finalize and return the SimulationReport.

pub fn to_html(self) -> String

Finalize and render as HTML.

pub fn to_markdown(self) -> String

Finalize and render as Markdown.

pub fn to_latex(self) -> String

Finalize and render as LaTeX.

Trait Implementations

impl Debug for ReportBuilder

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

Formats the value using the given formatter.

impl Default for ReportBuilder

fn default() -> ReportBuilder

Returns the “default value” for a type.