version-consts-git 0.2.0

Code generation for compiling in information about a crate's git status
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

use std::fmt;

use proc_macro_hack::proc_macro_hack;

/// Determine properties of the git working tree at the crate root, if any
///
/// # Example
/// ```
/// use version_consts_git::version;
/// fn main() {
///     match version!() {
///         None => eprintln!("not built from git"),
///         Some(x) => {
///             print!("{}", x.commit);
///             if x.dirty {
///                 println!(" (dirty)");
///             } else {
///                 println!();
///             }
///         }
///     }
/// }
/// ```

#[proc_macro_hack]
pub use version_consts_git_impl::version;

/// A concrete git commit
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
pub struct Commit(pub [u8; 20]);

impl std::ops::Deref for Commit {
    type Target = [u8];
    fn deref(&self) -> &[u8] {
        &self.0
    }
}

impl fmt::Display for Commit {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        for x in &self.0 {
            write!(f, "{:02x}", x)?;
        }
        Ok(())
    }
}

#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
pub struct Version {
    /// The current git commit
    pub commit: Commit,
    /// Whether there were uncommited changes
    pub dirty: bool,
}