Struct LineAnalysis

pub struct LineAnalysis {
    pub ignore: HashSet<Lines>,
    pub cover: HashSet<usize>,
    pub logical_lines: HashMap<usize, usize>,
    pub functions: HashMap<String, (usize, usize)>,
    /* private fields */
}

Represents the results of analysis of a single file. Does not store the file in question as this is expected to be maintained by the user.

Fields

ignore: HashSet<Lines>

This represents lines that should be ignored in coverage but may be identifed as coverable in the DWARF tables

cover: HashSet<usize>

This represents lines that should be included in coverage But may be ignored. Doesn’t make sense to cover ALL the lines so this is just an index.

logical_lines: HashMap<usize, usize>

Some logical lines may be split between physical lines this shows the mapping from physical line to logical line to prevent false positives from expressions split across physical lines

functions: HashMap<String, (usize, usize)>

Implementations

impl LineAnalysis

pub fn ignore_all(&mut self)

Ignore all lines in the file

pub fn ignore_tokens<T>(&mut self, tokens: T)

where T: ToTokens,

Ignore all tokens in the given token stream

pub fn ignore_span(&mut self, span: Span)

Adds the lines of the provided span to the ignore set

pub fn cover_token_stream( &mut self, tokens: TokenStream, contents: Option<&str>, )

Cover all tokens in the given tokenstream

pub fn cover_span(&mut self, span: Span, contents: Option<&str>)

Adds the lines of the provided span to the cover set

pub fn should_ignore(&self, line: usize) -> bool

Shows whether the line should be ignored by tarpaulin

Trait Implementations

impl Clone for LineAnalysis

fn clone(&self) -> LineAnalysis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LineAnalysis

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

Formats the value using the given formatter.

impl Default for LineAnalysis

fn default() -> LineAnalysis

Returns the “default value” for a type.