<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../git2/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Struct <ahref="index.html">git2</a>::<wbr><aclass="struct"href="#">Config</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../src/git2/config.rs.html#11-13">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct Config { <spanclass="comment">/* private fields */</span> }</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A structure representing a git configuration key/value store</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.find_global"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#112-119">source</a><h4class="code-header">pub fn <ahref="#method.find_global"class="fn">find_global</a>() -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/1.78.0/std/path/struct.PathBuf.html"title="struct std::path::PathBuf">PathBuf</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Locate the path to the global configuration file</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.find_system"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#124-131">source</a><h4class="code-header">pub fn <ahref="#method.find_system"class="fn">find_system</a>() -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/1.78.0/std/path/struct.PathBuf.html"title="struct std::path::PathBuf">PathBuf</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Locate the path to the system configuration file</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.find_xdg"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#137-144">source</a><h4class="code-header">pub fn <ahref="#method.find_xdg"class="fn">find_xdg</a>() -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/1.78.0/std/path/struct.PathBuf.html"title="struct std::path::PathBuf">PathBuf</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Locate the path to the global XDG compatible configuration file</p>
) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Add an on-disk config file instance to an existing config</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.remove"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#172-178">source</a><h4class="code-header">pub fn <ahref="#method.remove"class="fn">remove</a>(&mut self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Delete a config variable from the config file with the highest level
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_bool"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#198-205">source</a><h4class="code-header">pub fn <ahref="#method.get_bool"class="fn">get_bool</a>(&self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Get the value of a boolean config variable.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_i32"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#212-219">source</a><h4class="code-header">pub fn <ahref="#method.get_i32"class="fn">get_i32</a>(&self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.i32.html">i32</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Get the value of an integer config variable.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_i64"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#226-233">source</a><h4class="code-header">pub fn <ahref="#method.get_i64"class="fn">get_i64</a>(&self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.i64.html">i64</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Get the value of an integer config variable.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_str"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#241-244">source</a><h4class="code-header">pub fn <ahref="#method.get_str"class="fn">get_str</a>(&self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Get the value of a string config variable.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_bytes"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#249-256">source</a><h4class="code-header">pub fn <ahref="#method.get_bytes"class="fn">get_bytes</a>(&self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><&[<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.u8.html">u8</a>], <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Get the value of a string config variable as a byte slice.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_string"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#265-274">source</a><h4class="code-header">pub fn <ahref="#method.get_string"class="fn">get_string</a>(&self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/1.78.0/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Get the value of a string config variable as an owned string.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_path"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#285-292">source</a><h4class="code-header">pub fn <ahref="#method.get_path"class="fn">get_path</a>(&self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="https://doc.rust-lang.org/1.78.0/std/path/struct.PathBuf.html"title="struct std::path::PathBuf">PathBuf</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Get the value of a path config variable as an owned <code>PathBuf</code>.</p>
the standard <ahref="https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator"><code>Iterator</code></a> trait. See <ahref="struct.ConfigEntries.html"title="struct git2::ConfigEntries"><code>ConfigEntries</code></a> for more.</p>
) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.ConfigEntries.html"title="struct git2::ConfigEntries">ConfigEntries</a><'_>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Iterate over the values of a multivar</p>
the standard <ahref="https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator"><code>Iterator</code></a> trait. See <ahref="struct.ConfigEntries.html"title="struct git2::ConfigEntries"><code>ConfigEntries</code></a> for more.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.open_global"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#374-380">source</a><h4class="code-header">pub fn <ahref="#method.open_global"class="fn">open_global</a>(&mut self) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.Config.html"title="struct git2::Config">Config</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Open the global/XDG configuration file according to git’s rules</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.set_bool"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#396-402">source</a><h4class="code-header">pub fn <ahref="#method.set_bool"class="fn">set_bool</a>(&mut self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>, value: <aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Set the value of a boolean config variable in the config file with the
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.set_i32"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#406-412">source</a><h4class="code-header">pub fn <ahref="#method.set_i32"class="fn">set_i32</a>(&mut self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>, value: <aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.i32.html">i32</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Set the value of an integer config variable in the config file with the
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.set_i64"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#416-422">source</a><h4class="code-header">pub fn <ahref="#method.set_i64"class="fn">set_i64</a>(&mut self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>, value: <aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.i64.html">i64</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Set the value of an integer config variable in the config file with the
) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Set the value of an multivar config variable in the config file with the
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.set_str"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#440-447">source</a><h4class="code-header">pub fn <ahref="#method.set_str"class="fn">set_str</a>(&mut self, name: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>, value: &<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.unit.html">()</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Set the value of a string config variable in the config file with the
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.parse_i32"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#478-486">source</a><h4class="code-header">pub fn <ahref="#method.parse_i32"class="fn">parse_i32</a><S: <aclass="trait"href="trait.IntoCString.html"title="trait git2::IntoCString">IntoCString</a>>(s: S) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.i32.html">i32</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Parse a string as an i32; handles suffixes like k, M, or G, and
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.parse_i64"class="method"><aclass="src rightside"href="../src/git2/config.rs.html#490-498">source</a><h4class="code-header">pub fn <ahref="#method.parse_i64"class="fn">parse_i64</a><S: <aclass="trait"href="trait.IntoCString.html"title="trait git2::IntoCString">IntoCString</a>>(s: S) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.i64.html">i64</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Parse a string as an i64; handles suffixes like k, M, or G, and
<code><ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#805-807">source</a><ahref="#impl-TryFrom%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#812">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#790-792">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.78.0/src/core/convert/mod.rs.html#797">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
