Struct CoverageReport

pub struct CoverageReport {
    pub source_paths: HashMap<(Version, usize), PathBuf, RandomState>,
    pub source_paths_to_ids: HashMap<(Version, PathBuf), usize, RandomState>,
    pub items: HashMap<Version, Vec<CoverageItem>, RandomState>,
    pub anchors: HashMap<ContractId, (Vec<ItemAnchor>, Vec<ItemAnchor>), RandomState>,
    pub bytecode_hits: HashMap<ContractId, HitMap, RandomState>,
    pub source_maps: HashMap<ContractId, (Vec<SourceElement>, Vec<SourceElement>), RandomState>,
}

A coverage report.

A coverage report contains coverage items and opcodes corresponding to those items (called “anchors”). A single coverage item may be referred to by multiple anchors.

Fields

source_paths: HashMap<(Version, usize), PathBuf, RandomState>

A map of source IDs to the source path.

source_paths_to_ids: HashMap<(Version, PathBuf), usize, RandomState>

A map of source paths to source IDs.

items: HashMap<Version, Vec<CoverageItem>, RandomState>

All coverage items for the codebase, keyed by the compiler version.

anchors: HashMap<ContractId, (Vec<ItemAnchor>, Vec<ItemAnchor>), RandomState>

All item anchors for the codebase, keyed by their contract ID.

bytecode_hits: HashMap<ContractId, HitMap, RandomState>

All the bytecode hits for the codebase.

source_maps: HashMap<ContractId, (Vec<SourceElement>, Vec<SourceElement>), RandomState>

The bytecode -> source mappings.

Implementations

impl CoverageReport

pub fn add_source(&mut self, version: Version, source_id: usize, path: PathBuf)

Add a source file path.

pub fn get_source_id(&self, version: Version, path: PathBuf) -> Option<usize>

Get the source ID for a specific source file path.

pub fn add_source_maps( &mut self, source_maps: impl IntoIterator<Item = (ContractId, (Vec<SourceElement>, Vec<SourceElement>))>, )

Add the source maps.

pub fn add_items( &mut self, version: Version, items: impl IntoIterator<Item = CoverageItem>, )

Add coverage items to this report.

pub fn add_anchors( &mut self, anchors: impl IntoIterator<Item = (ContractId, (Vec<ItemAnchor>, Vec<ItemAnchor>))>, )

Add anchors to this report.

pub fn summary_by_file(&self) -> impl Iterator<Item = (&Path, CoverageSummary)>

Returns an iterator over coverage summaries by source file path.

pub fn items_by_file(&self) -> impl Iterator<Item = (&Path, Vec<&CoverageItem>)>

Returns an iterator over coverage items by source file path.

pub fn add_hit_map( &mut self, contract_id: &ContractId, hit_map: &HitMap, is_deployed_code: bool, ) -> Result<(), Report>

Processes data from a HitMap and sets hit counts for coverage items in this coverage map.

This function should only be called after all the relevant sources have been processed and added to the map (see add_source).

pub fn filter_out_ignored_sources(&mut self, filter: impl Fn(&Path) -> bool)

Removes all the coverage items that should be ignored by the filter.

This function should only be called after all the sources were used, otherwise, the output will be missing the ones that are dependent on them.

Trait Implementations

impl Clone for CoverageReport

fn clone(&self) -> CoverageReport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CoverageReport

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

Formats the value using the given formatter.

impl Default for CoverageReport

fn default() -> CoverageReport

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 240 bytes