source_loc 0.99.0

utility for capturing source file location at compile time
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

/// Captures a [SourceLoc](struct.SourceLoc.html) source location.
///
/// # Example
///
/// ```rust
/// use source_loc::source_loc;
///
/// let loc = source_loc!();
/// assert_eq!(
///     "src/source_loc.rs:6:11",
///     &loc.to_string(),
/// );
/// ```
#[macro_export]
macro_rules! source_loc {
    () => {
        crate::source_loc::SourceLoc {
            file: std::file!(),
            line: std::line!(),
            column: std::column!(),
        }
    };
}

// tests as early as possible so the line numbers are more stable : )
#[cfg(test)]
mod tests {
    #[test]
    fn it_can_debug() {
        let loc = source_loc!();
        assert_eq!("src/source_loc.rs:30:19", &format!("{:?}", loc));
    }

    #[test]
    fn it_can_display() {
        let loc = source_loc!();
        assert_eq!("src/source_loc.rs:36:19", &format!("{}", loc));
    }
}

/// A captured source location. To capture, use the [source_loc!()](macro.source_loc.html) macro.
///
/// # Example
///
/// ```rust
/// use source_loc::source_loc;
///
/// let loc = source_loc!();
///
/// assert_eq!(
///     "src/source_loc.rs:6:11",
///     &loc.to_string(),
/// );
///
/// assert_eq!(
///     "src/source_loc.rs",
///     loc.file,
/// );
///
/// assert_eq!(6, loc.line);
///
/// assert_eq!(11, loc.column);
/// ```
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
pub struct SourceLoc {
    pub file: &'static str,
    pub line: u32,
    pub column: u32,
}

impl std::fmt::Debug for SourceLoc {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}:{}:{}", self.file, self.line, self.column)
    }
}

impl std::fmt::Display for SourceLoc {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Debug::fmt(self, f)
    }
}