Struct Builder 

pub struct Builder { /* private fields */ }

A builder for a Report.

Implementations

impl Builder

pub fn title(self, title: impl Into<String>) -> Result<Self, Error>

Sets the title for the Builder.

Examples

use bitbelay_report::section::test;
use bitbelay_report::section::test::module::Result;
use bitbelay_report::section::test::Module;
use bitbelay_report::Builder;

let result = test::Builder::default()
    .title("Foo")?
    .description("Bar")?
    .push_module(Module::new(Result::Inconclusive, "Baz", None, None))
    .try_build()?;

let report = Builder::default()
    .title("Hello, world!")?
    .push_test_result(result)
    .try_build()?;

assert_eq!(report.title(), "Hello, world!");

pub fn push_test_result(self, result: Test) -> Self

Pushes a test result section into the Builder.

Examples

use bitbelay_report::section::test;
use bitbelay_report::section::test::module::Result;
use bitbelay_report::section::test::Module;
use bitbelay_report::Builder;

let result = test::Builder::default()
    .title("Foo")?
    .description("Bar")?
    .push_module(Module::new(Result::Inconclusive, "Baz", None, None))
    .try_build()?;

let report = Builder::default()
    .title("Hello, world!")?
    .push_test_result(result.clone())
    .try_build()?;

assert_eq!(report.sections().len(), 1);
assert_eq!(report.sections().first().as_test_result().unwrap(), &result);

pub fn try_build(self) -> Result<Report, Error>

Consumes self and attempts to build a Report.

Examples

use bitbelay_report::section::test;
use bitbelay_report::section::test::module::Result;
use bitbelay_report::section::test::Module;
use bitbelay_report::Builder;

let result = test::Builder::default()
    .title("Foo")?
    .description("Bar")?
    .push_module(Module::new(Result::Inconclusive, "Baz", None, None))
    .try_build()?;

let report = Builder::default()
    .title("Hello, world!")?
    .push_test_result(result.clone())
    .try_build()?;

assert_eq!(report.title(), "Hello, world!");
assert_eq!(report.sections().len(), 1);
assert_eq!(report.sections().first().as_test_result().unwrap(), &result);

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.