<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source to the Rust file `src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../git_info/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="attribute">#![<span class="ident">deny</span>(
<span class="ident">absolute_paths_not_starting_with_crate</span>,
<span class="ident">ambiguous_associated_items</span>,
<span class="ident">anonymous_parameters</span>,
<span class="ident">arithmetic_overflow</span>,
<span class="ident">array_into_iter</span>,
<span class="ident">bindings_with_variant_name</span>,
<span class="ident">coherence_leak_check</span>,
<span class="ident">conflicting_repr_hints</span>,
<span class="ident">const_err</span>,
<span class="ident">dead_code</span>,
<span class="ident">deprecated</span>,
<span class="ident">deprecated_in_future</span>,
<span class="ident">ellipsis_inclusive_range_patterns</span>,
<span class="ident">explicit_outlives_requirements</span>,
<span class="ident">exported_private_dependencies</span>,
<span class="ident">ill_formed_attribute_input</span>,
<span class="ident">illegal_floating_point_literal_pattern</span>,
<span class="ident">improper_ctypes</span>,
<span class="ident">incomplete_features</span>,
<span class="ident">indirect_structural_match</span>,
<span class="ident">inline_no_sanitize</span>,
<span class="ident">invalid_codeblock_attribute</span>,
<span class="ident">invalid_type_param_default</span>,
<span class="ident">invalid_value</span>,
<span class="ident">irrefutable_let_patterns</span>,
<span class="ident">keyword_idents</span>,
<span class="ident">late_bound_lifetime_arguments</span>,
<span class="ident">macro_expanded_macro_exports_accessed_by_absolute_paths</span>,
<span class="ident">meta_variable_misuse</span>,
<span class="ident">missing_copy_implementations</span>,
<span class="ident">missing_crate_level_docs</span>,
<span class="ident">missing_docs</span>,
<span class="ident">missing_fragment_specifier</span>,
<span class="ident">mutable_borrow_reservation_conflict</span>,
<span class="ident">mutable_transmutes</span>,
<span class="ident">no_mangle_const_items</span>,
<span class="ident">no_mangle_generic_items</span>,
<span class="ident">non_ascii_idents</span>,
<span class="ident">non_camel_case_types</span>,
<span class="ident">non_shorthand_field_patterns</span>,
<span class="ident">non_snake_case</span>,
<span class="ident">non_upper_case_globals</span>,
<span class="ident">order_dependent_trait_objects</span>,
<span class="ident">overflowing_literals</span>,
<span class="ident">overlapping_patterns</span>,
<span class="ident">path_statements</span>,
<span class="ident">patterns_in_fns_without_body</span>,
<span class="ident">private_doc_tests</span>,
<span class="ident">private_in_public</span>,
<span class="ident">proc_macro_derive_resolution_fallback</span>,
<span class="ident">pub_use_of_private_extern_crate</span>,
<span class="ident">redundant_semicolons</span>,
<span class="ident">safe_packed_borrows</span>,
<span class="ident">soft_unstable</span>,
<span class="ident">stable_features</span>,
<span class="ident">trivial_bounds</span>,
<span class="ident">trivial_casts</span>,
<span class="ident">trivial_numeric_casts</span>,
<span class="ident">type_alias_bounds</span>,
<span class="ident">tyvar_behind_raw_pointer</span>,
<span class="ident">uncommon_codepoints</span>,
<span class="ident">unconditional_panic</span>,
<span class="ident">unconditional_recursion</span>,
<span class="ident">unknown_crate_types</span>,
<span class="ident">unnameable_test_items</span>,
<span class="ident">unreachable_code</span>,
<span class="ident">unreachable_patterns</span>,
<span class="ident">unreachable_pub</span>,
<span class="ident">unsafe_code</span>,
<span class="ident">unstable_features</span>,
<span class="ident">unstable_name_collisions</span>,
<span class="ident">unused_allocation</span>,
<span class="ident">unused_assignments</span>,
<span class="ident">unused_attributes</span>,
<span class="ident">unused_braces</span>,
<span class="ident">unused_comparisons</span>,
<span class="ident">unused_doc_comments</span>,
<span class="ident">unused_extern_crates</span>,
<span class="ident">unused_features</span>,
<span class="ident">unused_import_braces</span>,
<span class="ident">unused_imports</span>,
<span class="ident">unused_labels</span>,
<span class="ident">unused_lifetimes</span>,
<span class="ident">unused_macros</span>,
<span class="ident">unused_must_use</span>,
<span class="ident">unused_mut</span>,
<span class="ident">unused_parens</span>,
<span class="ident">unused_qualifications</span>,
<span class="ident">unused_unsafe</span>,
<span class="ident">unused_variables</span>,
<span class="ident">where_clauses_object_safety</span>,
<span class="ident">while_true</span>
)]</span>
<span class="attribute">#![<span class="ident">warn</span>(<span class="ident">macro_use_extern_crate</span>, <span class="ident">unknown_lints</span>)]</span>
<span class="attribute">#![<span class="ident">allow</span>(
<span class="ident">bare_trait_objects</span>,
<span class="ident">box_pointers</span>,
<span class="ident">elided_lifetimes_in_paths</span>,
<span class="ident">intra_doc_link_resolution_failure</span>,
<span class="ident">missing_doc_code_examples</span>,
<span class="ident">missing_debug_implementations</span>,
<span class="ident">single_use_lifetimes</span>,
<span class="ident">unused_results</span>,
<span class="ident">variant_size_differences</span>,
<span class="ident">warnings</span>,
<span class="ident">renamed_and_removed_lints</span>
)]</span>
<span class="doccomment">//! # git_info</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Extracts git repository information.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This library main goal is to provide development/build tools such as</span>
<span class="doccomment">//! [cargo-make](https://sagiegurari.github.io/cargo-make/)the needed information on the current git repository.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Examples</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! fn main() {</span>
<span class="doccomment">//! let info = git_info::get();</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! println!("User Name: {}", info.user_name.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">//! println!("User Email: {}", info.user_email.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">//! println!("Dirty: {}", info.dirty.unwrap_or(false));</span>
<span class="doccomment">//! println!("Current Branch: {}", info.current_branch.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">//! println!("Last Commit Hash: {}", info.head.last_commit_hash.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">//! println!("Last Commit Hash (short): {}", info.head.last_commit_hash_short.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">//! println!("Config: {:#?}", info.config.unwrap());</span>
<span class="doccomment">//! println!("Branches: {:#?}", info.branches.unwrap_or(vec![]));</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Installation</span>
<span class="doccomment">//! In order to use this library, just add it as a dependency:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```ini</span>
<span class="doccomment">//! [dependencies]</span>
<span class="doccomment">//! git_info = "*"</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Contributing</span>
<span class="doccomment">//! See [contributing guide](https://github.com/sagiegurari/git_info/blob/master/.github/CONTRIBUTING.md)</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # License</span>
<span class="doccomment">//! Developed by Sagie Gur-Ari and licensed under the</span>
<span class="doccomment">//! [Apache 2](https://github.com/sagiegurari/git_info/blob/master/LICENSE) open source license.</span>
<span class="doccomment">//!</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"./lib_test.rs"</span>]</span>
<span class="kw">mod</span> <span class="ident">lib_test</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">doctest</span>)]</span>
<span class="ident">doc_comment</span>::<span class="macro">doctest</span><span class="macro">!</span>(<span class="string">"../README.md"</span>);
<span class="kw">mod</span> <span class="ident">gitinfo</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">types</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">types</span>::<span class="ident">GitInfo</span>;
<span class="doccomment">/// Returns the current git repository information.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// fn main() {</span>
<span class="doccomment">/// let info = git_info::get();</span>
<span class="doccomment">///</span>
<span class="doccomment">/// println!("User Name: {}", info.user_name.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">/// println!("User Email: {}", info.user_email.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">/// println!("Dirty: {}", info.dirty.unwrap_or(false));</span>
<span class="doccomment">/// println!("Current Branch: {}", info.current_branch.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">/// println!("Last Commit Hash: {}", info.head.last_commit_hash.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">/// println!("Last Commit Hash (short): {}", info.head.last_commit_hash_short.unwrap_or("Unknown".to_string()));</span>
<span class="doccomment">/// println!("Config: {:#?}", info.config.unwrap());</span>
<span class="doccomment">/// println!("Branches: {:#?}", info.branches.unwrap_or(vec![]));</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get</span>() <span class="op">-</span><span class="op">></span> <span class="ident">GitInfo</span> {
<span class="ident">gitinfo</span>::<span class="ident">get</span>()
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "git_info";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>