Struct cargo_tarpaulin::traces::TraceMap

pub struct TraceMap { /* private fields */ }

Stores all the program traces mapped to files and provides an interface to add, query and change traces.

Implementations

impl TraceMap

pub fn new() -> TraceMap

Create a new TraceMap

pub fn is_empty(&self) -> bool

Returns true if there are no traces

pub fn iter(&self) -> Iter<'_, PathBuf, Vec<Trace>>

Provides an interator to the underlying map of PathBufs to Vec

pub fn merge(&mut self, other: &TraceMap)

Merges the results of one tracemap into the current one. This adds records which are missing and adds the statistics gathered to existing records

pub fn dedup(&mut self)

This will collapse duplicate Traces into a single trace. Warning this will lose the addresses of the duplicate traces but increment the results should be called only if you don’t need those addresses from then on TODO possibly not the cleanest solution

pub fn add_trace(&mut self, file: &Path, trace: Trace)

Add a trace to the tracemap for the given file

pub fn add_file(&mut self, file: &Path)

pub fn get_trace(&self, address: u64) -> Option<&Trace>

Gets an immutable reference to a trace from an address. Returns None if there is no trace at that address

pub fn increment_hit(&mut self, address: u64)

pub fn get_trace_mut(&mut self, address: u64) -> Option<&mut Trace>

Gets a mutable reference to a trace at a given address Returns None if there is no trace at that address

pub fn get_location(&self, address: u64) -> Option<Location>

pub fn contains_location(&self, file: &Path, line: u64) -> bool

Returns true if the location described by file and line number is present in the tracemap

pub fn contains_file(&self, file: &Path) -> bool

Returns true if the file is among the traces

pub fn get_child_traces<'a>(
    &'a self,
    root: &'a Path
) -> impl Iterator<Item = &'a Trace> + 'a

Gets all traces below a certain path

pub fn get_traces<'a>(
    &'a self,
    root: &'a Path
) -> impl Iterator<Item = &'a Trace> + 'a

Gets all traces in folder, doesn’t go into other folders for that you want get_child_traces

pub fn all_traces(&self) -> impl Iterator<Item = &Trace>

Gets all traces

pub fn files(&self) -> Vec<&PathBuf>

pub fn coverable_in_path(&self, path: &Path) -> usize

pub fn covered_in_path(&self, path: &Path) -> usize

pub fn total_coverable(&self) -> usize

Give the total amount of coverable points in the code. This will vary based on the statistics available for line coverage it will be total lines whereas for condition or decision it will count the number of conditions available

pub fn total_covered(&self) -> usize

From all the coverable data return the amount covered

pub fn coverage_percentage(&self) -> f64

Returns coverage percentage ranging from 0.0-1.0

Trait Implementations

impl Debug for TraceMap

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

Formats the value using the given formatter.

impl Default for TraceMap

fn default() -> TraceMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TraceMap

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

Deserialize this value from the given Serde deserializer.

impl From<&TraceMap> for CoverageReport

fn from(coverage_data: &TraceMap) -> Self

Converts to this type from the input type.

impl From<&TraceMap> for Result<String, Error>

fn from(val: &TraceMap) -> Self

Converts to this type from the input type.

impl From<&TraceMap> for Vec<SourceFile>

fn from(coverage_data: &TraceMap) -> Self

Converts to this type from the input type.

impl Serialize for TraceMap

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

Serialize this value into the given Serde serializer.