Struct lcov::filter::line_num::LineNum

pub struct LineNum { /* fields omitted */ }

A Section filter that extracts only the records related to the specified line numbers.

This filter is useful for measuring the coverage of the part changed by a specific commit.

Examples

use lcov::Report;
use lcov::filter::{FilterMap, LineNum};
use std::collections::HashMap;
use std::path::PathBuf;
use std::iter::FromIterator;

// Creates a `Report` from file.
let mut report = Report::from_file("report.info")?;

// Setup the filter.
let mut filter = HashMap::new();
filter.insert(
    PathBuf::from("foo.rs"),
    LineNum::from_iter([0..5, 10..20].iter().cloned())
);

// Filters the coverage information.
report.sections.filter_map(|(key, mut value)| {
    filter.get(&key.source_file).and_then(|filter| {
        filter.apply(&mut value);
        if value.is_empty() { None } else { Some((key, value)) }
    })
});

Implementations

impl LineNum

pub fn new() -> Self

Creates an empty filter.

An empty filter filters out all records.

Examples

use lcov::filter::line_num::LineNum;

let filter = LineNum::new();

pub fn insert<R>(&mut self, range: R) where
    R: Into<Range>, 

Inserts a range of lines that those coverage information should be yielded.

Examples

use lcov::filter::line_num::LineNum;

let mut filter = LineNum::new();

filter.insert(3..4);
filter.insert(7..10);

pub fn apply(&self, section: &mut Value)

Applies the filter to section.

Examples

use lcov::Report;
use lcov::filter::{FilterMap, LineNum};
use std::collections::HashMap;
use std::path::PathBuf;
use std::iter::FromIterator;

// Creates a `Report` from file.
let mut report = Report::from_file("report.info")?;

// Setup the filter.
let mut filter = HashMap::new();
filter.insert(
    PathBuf::from("foo.rs"),
    LineNum::from_iter([0..5, 10..20].iter().cloned())
);

// Filters the coverage information.
report.sections.filter_map(|(key, mut value)| {
    filter.get(&key.source_file).and_then(|filter| {
        filter.apply(&mut value);
        if value.is_empty() { None } else { Some((key, value)) }
    })
});

Trait Implementations

impl Clone for LineNum

fn clone(&self) -> LineNum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LineNum

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

Formats the value using the given formatter.

impl Default for LineNum

fn default() -> LineNum

Returns the “default value” for a type.

impl<R> Extend<R> for LineNum where
    R: Into<Range>, 

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = R>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<R> FromIterator<R> for LineNum where
    R: Into<Range>, 

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = R>, 

Creates a value from an iterator.

impl PartialEq<LineNum> for LineNum

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

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

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

This method tests for !=.

impl Eq for LineNum

impl StructuralEq for LineNum

impl StructuralPartialEq for LineNum