Struct lcov::report::Report

pub struct Report {
    pub sections: Sections,
}

An accumulated coverage information from some LCOV tracefiles.

Report is used for merging/filtering the coverage information.

Examples

Merges LCOV tracefiles and outputs the result in LCOV tracefile format:

use lcov::Report;

let mut report = Report::new();

// Merges a first file.
report.merge(Report::from_file("report_a.info")?)?;

// Merges a second file.
report.merge(Report::from_file("report_b.info")?)?;

// Outputs the merge result in LCOV tracefile format.
for record in report.into_records() {
    println!("{}", record);
}

Fields

sections: Sections

Coverage information about every source files.

Implementations

impl Report

pub fn new() -> Self

Creates an empty report.

Examples

use lcov::Report;
let report = Report::new();

pub fn from_reader<I, E>(iter: I) -> Result<Self, ParseError> where
    I: IntoIterator<Item = Result<Record, E>>,
    E: Into<ReadError>, 

Creates a report from LCOV record reader.

Examples

use lcov::{Report, Reader};

let input = "\
TN:test_name
SF:/path/to/source/file.rs
DA:1,2
DA:3,0
DA:5,6
LF:3
LH:2
end_of_record
";
let reader = Reader::new(input.as_bytes());
let report = Report::from_reader(reader)?;

pub fn from_file<P>(path: P) -> Result<Self, ParseError> where
    P: AsRef<Path>, 

Creates a report from LCOV tracefile.

Examples

use lcov::Report;

let report = Report::from_file("report.info")?;

pub fn merge(&mut self, other: Self) -> Result<(), MergeError>

Merges a report into self.

Examples

use lcov::Report;

let mut report = Report::from_file("report1.info")?;
report.merge(Report::from_file("report2.info")?)?;

pub fn merge_lossy(&mut self, other: Self)

Merges a report into self with ignoring an Errors.

Examples

use lcov::Report;

let mut report = Report::from_file("report1.info")?;
report.merge_lossy(Report::from_file("report2.info")?);

pub fn into_records(self) -> IntoRecordsⓘ

Important traits for IntoRecords

impl Iterator for IntoRecords type Item = Record;

Creates an iterator which iterates over [LCOV section].

Examples

use lcov::Report;

let mut report = Report::from_file("report.info")?;
// ... Manipulate report
for record in report.into_records() {
   println!("{}", record);
}

Trait Implementations

impl Clone for Report

fn clone(&self) -> Report

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl Default for Report

fn default() -> Report

Returns the "default value" for a type.

impl Eq for Report

impl PartialEq<Report> for Report

fn eq(&self, other: &Report) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Report) -> bool

This method tests for !=.

impl StructuralEq for Report

impl StructuralPartialEq for Report