Struct CoverageResult 

pub struct CoverageResult {
    pub name: String,
    pub version: String,
    pub line_pct: f64,
    pub function_pct: f64,
    pub region_pct: f64,
    pub total_lines: u64,
    pub covered_lines: u64,
}

Result of a coverage run.

Fields

name: String

Crate name.

version: String

Crate version.

line_pct: f64

Percentage of executable lines that were exercised by tests.

function_pct: f64

Percentage of functions that were called by tests.

region_pct: f64

Percentage of regions (branch points) that were exercised.

total_lines: u64

Total executable lines in the crate.

covered_lines: u64

Lines that were exercised at least once.

Implementations

impl CoverageResult

pub fn into_check_result(self, threshold: CoverageThreshold) -> CheckResult

Convert this result into a CheckResult against the given threshold.

Examples found in repository

examples/basic.rs (line 16)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let run = CoverageRun::new("example", "0.1.0");
    let result = run.execute()?;

    println!("Line coverage:     {:.2}%", result.line_pct);
    println!("Function coverage: {:.2}%", result.function_pct);
    println!("Region coverage:   {:.2}%", result.region_pct);

    let threshold = CoverageThreshold::min_line_pct(80.0);
    let check = result.into_check_result(threshold);
    println!("\nVerdict: {:?}", check.verdict);
    if let Some(d) = check.detail {
        println!("Detail:  {d}");
    }
    Ok(())
}

Trait Implementations

impl Clone for CoverageResult

fn clone(&self) -> CoverageResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoverageResult

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

Formats the value using the given formatter.