Struct FileCoverage

pub struct FileCoverage {
    pub all: bool,
    pub path: String,
    pub statement_map: IndexMap<u32, Range>,
    pub fn_map: IndexMap<u32, Function>,
    pub branch_map: IndexMap<u32, Branch>,
    pub s: IndexMap<u32, u32>,
    pub f: IndexMap<u32, u32>,
    pub b: IndexMap<u32, Vec<u32>>,
    pub b_t: Option<IndexMap<u32, Vec<u32>>>,
    pub input_source_map: Option<SourceMap>,
}

provides a read-only view of coverage for a single file. It has the following properties: path - the file path for which coverage is being tracked statementMap - map of statement locations keyed by statement index fnMap - map of function metadata keyed by function index branchMap - map of branch metadata keyed by branch index s - hit counts for statements f - hit count for functions b - hit count for branches

Note: internally it uses IndexMap to represent key-value pairs for the coverage data, as logic for merge relies on the order of keys in the map.

Fields

all: bool

path: String

statement_map: IndexMap<u32, Range>

fn_map: IndexMap<u32, Function>

branch_map: IndexMap<u32, Branch>

s: IndexMap<u32, u32>

f: IndexMap<u32, u32>

b: IndexMap<u32, Vec<u32>>

b_t: Option<IndexMap<u32, Vec<u32>>>

input_source_map: Option<SourceMap>

Implementations

impl FileCoverage

pub fn empty(file_path: String, report_logic: bool) -> FileCoverage

pub fn from_file_path(file_path: String, report_logic: bool) -> FileCoverage

pub fn from_file_coverage(coverage: &FileCoverage) -> FileCoverage

pub fn get_line_coverage(&self) -> IndexMap<u32, u32>

Returns computed line coverage from statement coverage. This is a map of hits keyed by line number in the source.

pub fn get_uncovered_lines(&self) -> Vec<u32>

Returns an array of uncovered line numbers.

pub fn get_branch_coverage_by_line(&self) -> IndexMap<u32, Coverage>

pub fn to_json()

pub fn merge(&mut self, coverage: &FileCoverage)

Merges a second coverage object into this one, updating hit counts

pub fn compute_simple_totals<T>(line_map: &IndexMap<T, u32>) -> Totals

pub fn reset_hits(&mut self)

pub fn to_summary(&self) -> CoverageSummary

Trait Implementations

impl Clone for FileCoverage

fn clone(&self) -> FileCoverage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileCoverage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileCoverage

fn deserialize<__D>( __deserializer: __D, ) -> Result<FileCoverage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FileCoverage

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FileCoverage

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileCoverage