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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use super::RecordKind;
use crate::reader;

/// All possible errors that can occur when parsing LCOV records.
#[derive(Debug, thiserror::Error)]
pub enum ParseError {
    /// An error indicating that reading record operation failed.
    ///
    /// This error occurs when the underlying reader returns an error.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use matches::assert_matches;
    /// # fn main() {
    /// use lcov::{Reader, Report};
    /// use lcov::report::ParseError;
    /// assert_matches!(Report::from_reader(Reader::new("FOO:1,2,3".as_bytes())), Err(ParseError::Read(_)));
    /// # }
    /// ```
    #[error("failed to read record: {}", _0)]
    Read(#[from] reader::Error),

    /// An error indicating that unexpected kind of record is read.
    ///
    /// This error occurs when the LCOV tracefile (or underlying reader) contains invalid record sequence.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use matches::assert_matches;
    /// # fn main() {
    /// use lcov::{Reader, Report, RecordKind};
    /// use lcov::report::ParseError;
    /// let input = "\
    /// TN:test_name
    /// SF:/usr/include/stdio.h
    /// TN:next_test
    /// ";
    /// assert_matches!(Report::from_reader(Reader::new(input.as_bytes())),
    ///                 Err(ParseError::UnexpectedRecord { found: RecordKind::TestName, expected: RecordKind::EndOfRecord }));
    /// # }
    /// ```
    #[error("unexpected record found `{}`, expected `{}`", found, expected)]
    UnexpectedRecord {
        /// found record kind
        found: RecordKind,
        /// expected record kind
        expected: RecordKind,
    },

    /// An error indicating that unexpected "end of file".
    ///
    /// This error occurs when the LCOV tracefile (or underlying reader) contains invalid record sequence.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use matches::assert_matches;
    /// # fn main() {
    /// use lcov::{Reader, Report};
    /// use lcov::report::ParseError;
    /// let input = "\
    /// TN:test_name
    /// SF:/usr/include/stdio.h
    /// ";
    /// assert_matches!(Report::from_reader(Reader::new(input.as_bytes())),
    ///                 Err(ParseError::UnexpectedEof));
    /// # }
    /// ```
    #[error("unexpected end of file")]
    UnexpectedEof,
}

/// All possible errors that can occur when merging LCOV records.
#[derive(Debug, Copy, Clone, Eq, PartialEq, thiserror::Error)]
pub enum MergeError {
    /// An error indicating that start line of functions are not same.
    ///
    /// This error occurs when merging not compatible LCOV tracefiles.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use matches::assert_matches;
    /// # fn try_main() -> Result<(), Box<dyn std::error::Error>> {
    /// use lcov::{Reader, Report};
    /// use lcov::report::MergeError;
    /// let input1 = "\
    /// TN:test_name
    /// SF:foo.c
    /// FN:3,foo
    /// end_of_record
    /// ";
    /// let input2 = "\
    /// TN:test_name
    /// SF:foo.c
    /// FN:4,foo
    /// end_of_record
    /// ";
    /// let mut report1 = Report::from_reader(Reader::new(input1.as_bytes()))?;
    /// let report2 = Report::from_reader(Reader::new(input2.as_bytes()))?;
    /// assert_matches!(report1.merge(report2),
    ///                 Err(MergeError::UnmatchedFunctionLine));
    /// # Ok(())
    /// # }
    /// # fn main() {
    /// # try_main().expect("failed to run test");
    /// # }
    /// ```
    #[error("unmatched start line of function")]
    UnmatchedFunctionLine,

    /// An error indicating that checksum of lines are not same.
    ///
    /// This error occurs when merging not compatible LCOV tracefiles.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use matches::assert_matches;
    /// # fn try_main() -> Result<(), Box<dyn std::error::Error>> {
    /// use lcov::{Reader, Report};
    /// use lcov::report::MergeError;
    /// let input1 = "\
    /// TN:test_name
    /// SF:foo.c
    /// DA:4,1,valid_checksum
    /// end_of_record
    /// ";
    /// let input2 = "\
    /// TN:test_name
    /// SF:foo.c
    /// DA:4,4,invalid_checksum
    /// end_of_record
    /// ";
    /// let mut report1 = Report::from_reader(Reader::new(input1.as_bytes()))?;
    /// let report2 = Report::from_reader(Reader::new(input2.as_bytes()))?;
    /// assert_matches!(report1.merge(report2),
    ///                 Err(MergeError::UnmatchedChecksum));
    /// # Ok(())
    /// # }
    /// # fn main() {
    /// # try_main().expect("failed to run test");
    /// # }
    /// ```
    #[error("unmatched checksum")]
    UnmatchedChecksum,
}