lcov 0.8.2

LCOV tracefile parser/merger/filter in pure Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

//! A coverage information about a branch.
//!
//! Some coverage information is stored in a [`Branches`] as `BTreeMap` .
//!
//! [`Branches`]: ./type.Branches.html
use super::{Merge, MergeError, Record};
use std::collections::BTreeMap;
use std::iter;

/// A map of coverage information about branches.
pub type Branches = BTreeMap<Key, Value>;

/// A key of a coverage information about a branch.
///
/// This struct is used as a key of [`Branches`].
///
/// [`Branches`]: ./type.Branches.html
#[derive(Debug, Copy, Clone, Hash, Ord, PartialOrd, Eq, PartialEq)]
pub struct Key {
    /// Line number.
    pub line: u32,
    /// Block number.
    pub block: u32,
    /// Branch number.
    pub branch: u32,
}

/// A value of a coverage information about a branch.
///
/// This struct is used as a value of [`Branches`].
///
/// [`Branches`]: ./type.Branches.html
#[derive(Debug, Copy, Clone, Default, Eq, PartialEq)]
pub struct Value {
    /// A number indicating how often that branch was taken.
    pub taken: Option<u64>,
}

impl Merge for Value {
    fn merge(&mut self, other: Self) -> Result<(), MergeError> {
        self.merge_lossy(other);
        Ok(())
    }

    fn merge_lossy(&mut self, other: Self) {
        if let Value { taken: Some(taken) } = other {
            self.taken = Some(self.taken.unwrap_or(0) + taken);
        }
    }
}

pub(crate) fn into_records(branches: Branches) -> Box<dyn Iterator<Item = Record>> {
    if branches.is_empty() {
        return Box::new(iter::empty());
    }

    let found = branches.len() as u32;

    enum Branch {
        Data((Key, Value)),
        Found,
        Hit(u32),
    }
    let iter = branches
        .into_iter()
        .map(Branch::Data)
        .chain(iter::once(Branch::Found))
        .chain(iter::once(Branch::Hit(0)))
        .scan(0, |hit_count, mut rec| {
            match rec {
                Branch::Data((_, ref data)) => {
                    if data.taken.unwrap_or(0) > 0 {
                        *hit_count += 1
                    }
                }
                Branch::Found => {}
                Branch::Hit(ref mut hit) => *hit = *hit_count,
            }
            Some(rec)
        })
        .map(move |rec| match rec {
            Branch::Data((key, data)) => Record::BranchData {
                line: key.line,
                block: key.block,
                branch: key.branch,
                taken: data.taken,
            },
            Branch::Found => Record::BranchesFound { found },
            Branch::Hit(hit) => Record::BranchesHit { hit },
        });

    Box::new(iter)
}