1 ../coverage/doctest.rs:
2 1| |//! This test ensures that code from doctests is properly re-mapped.
3 2| |//! See <https://github.com/rust-lang/rust/issues/79417> for more info.
5 4| |//! Just some random code:
8 7| |//! // this is executed!
9 8| 1|//! assert_eq!(1, 1);
11 10| |//! // this is not!
12 11| |//! assert_eq!(1, 2);
16 15| |//! doctest testing external code:
18 17| 1|//! extern crate doctest_crate;
19 18| 1|//! doctest_crate::fn_run_in_doctests(1);
22 21| |//! doctest returning a result:
24 23| 2|//! #[derive(Debug, PartialEq)]
26 24| 1|//! struct SomeError {
27 25| 1|//! msg: String,
29 27| 1|//! let mut res = Err(SomeError { msg: String::from("a message") });
30 28| 1|//! if res.is_ok() {
33 31| 1|//! if *res.as_ref().unwrap_err() == *res.as_ref().unwrap_err() {
34 32| 1|//! println!("{:?}", res);
37 34| 1|//! if *res.as_ref().unwrap_err() == *res.as_ref().unwrap_err() {
38 35| 1|//! res = Ok(1);
41 37| 1|//! res = Ok(0);
43 39| |//! // need to be explicit because rustdoc cant infer the return type
44 40| 1|//! Ok::<(), SomeError>(())
47 43| |//! doctest with custom main:
49 45| 1|//! fn some_func() {
50 46| 1|//! println!("called some_func()");
53 49| |//! #[derive(Debug)]
54 50| |//! struct SomeError;
56 52| |//! extern crate doctest_crate;
58 54| 1|//! fn doctest_main() -> Result<(), SomeError> {
59 55| 1|//! some_func();
60 56| 1|//! doctest_crate::fn_run_in_doctests(2);
64 60| |//! // this `main` is not shown as covered, as it clashes with all the other
65 61| |//! // `main` functions that were automatically generated for doctests
66 62| |//! fn main() -> Result<(), SomeError> {
67 63| |//! doctest_main()
71 67| |/// doctest attached to fn testing external code:
73 69| 1|/// extern crate doctest_crate;
74 70| 1|/// doctest_crate::fn_run_in_doctests(3);
79 75| 1| assert_eq!(1, 1);
81 77| | assert_eq!(1, 2);
85 81| |// FIXME(Swatinem): Fix known issue that coverage code region columns need to be offset by the
86 82| |// doc comment line prefix (`///` or `//!`) and any additional indent (before or after the doc
87 83| |// comment characters). This test produces `llvm-cov show` results demonstrating the problem.
89 85| |// One of the above tests now includes: `derive(Debug, PartialEq)`, producing an `llvm-cov show`
90 86| |// result with a distinct count for `Debug`, denoted by `^1`, but the caret points to the wrong
91 87| |// column. Similarly, the `if` blocks without `else` blocks show `^0`, which should point at, or
92 88| |// one character past, the `if` block's closing brace. In both cases, these are most likely off
93 89| |// by the number of characters stripped from the beginning of each doc comment line: indent
94 90| |// whitespace, if any, doc comment prefix (`//!` in this case) and (I assume) one space character
95 91| |// (?). Note, when viewing `llvm-cov show` results in `--color` mode, the column offset errors are
96 92| |// more pronounced, and show up in more places, with background color used to show some distinct
97 93| |// code regions with different coverage counts.
99 95| |// NOTE: Since the doc comment line prefix may vary, one possible solution is to replace each
100 96| |// character stripped from the beginning of doc comment lines with a space. This will give coverage
101 97| |// results the correct column offsets, and I think it should compile correctly, but I don't know
102 98| |// what affect it might have on diagnostic messages from the compiler, and whether anyone would care
103 99| |// if the indentation changed. I don't know if there is a more viable solution.
105 ../coverage/lib/doctest_crate.rs:
106 1| |/// A function run only from within doctests
107 2| 3|pub fn fn_run_in_doctests(conditional: usize) {
108 3| 3| match conditional {
109 4| 1| 1 => assert_eq!(1, 1), // this is run,
110 5| 1| 2 => assert_eq!(1, 1), // this,
111 6| 1| 3 => assert_eq!(1, 1), // and this too
112 7| 0| _ => assert_eq!(1, 2), // however this is not