git_info2 0.1.2

Extracts git repository information.
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

//! # types
//!
//! Public library types.
//!

#[cfg(test)]
#[path = "./types_test.rs"]
mod types_test;

use std::collections::HashMap;

#[derive(Debug, Clone, Default)]
/// Holds git head info
pub struct Head {
    /// The last commit hash
    pub last_commit_hash: Option<String>,
    /// The last commit hash short prefix
    pub last_commit_hash_short: Option<String>,
}

impl Head {
    /// Returns new instance
    pub fn new() -> Head {
        Default::default()
    }
}

#[derive(Debug, Clone, Default)]
/// Holds git info for the given repo directory
pub struct GitInfo {
    /// User name
    pub user_name: Option<String>,
    /// User email
    pub user_email: Option<String>,
    /// True if there are non commited changes
    pub dirty: Option<bool>,
    /// Current branch name
    pub current_branch: Option<String>,
    /// All branch names
    pub branches: Option<Vec<String>>,
    /// Head information
    pub head: Head,
    /// Config key/value map
    pub config: Option<HashMap<String, String>>,
}

impl GitInfo {
    /// Returns new instance
    pub fn new() -> GitInfo {
        Default::default()
    }
}