mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-10 01:58:23 +00:00
147 lines
52 KiB
HTML
147 lines
52 KiB
HTML
<!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="A structure representing a git configuration key/value store"><title>Config in git2 - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="git2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../git2/index.html">git2</a><span class="version">0.18.2</span></h2></div><h2 class="location"><a href="#">Config</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.add_file">add_file</a></li><li><a href="#method.entries">entries</a></li><li><a href="#method.find_global">find_global</a></li><li><a href="#method.find_system">find_system</a></li><li><a href="#method.find_xdg">find_xdg</a></li><li><a href="#method.get_bool">get_bool</a></li><li><a href="#method.get_bytes">get_bytes</a></li><li><a href="#method.get_entry">get_entry</a></li><li><a href="#method.get_i32">get_i32</a></li><li><a href="#method.get_i64">get_i64</a></li><li><a href="#method.get_path">get_path</a></li><li><a href="#method.get_str">get_str</a></li><li><a href="#method.get_string">get_string</a></li><li><a href="#method.multivar">multivar</a></li><li><a href="#method.new">new</a></li><li><a href="#method.open">open</a></li><li><a href="#method.open_default">open_default</a></li><li><a href="#method.open_global">open_global</a></li><li><a href="#method.open_level">open_level</a></li><li><a href="#method.parse_bool">parse_bool</a></li><li><a href="#method.parse_i32">parse_i32</a></li><li><a href="#method.parse_i64">parse_i64</a></li><li><a href="#method.remove">remove</a></li><li><a href="#method.remove_multivar">remove_multivar</a></li><li><a href="#method.set_bool">set_bool</a></li><li><a href="#method.set_i32">set_i32</a></li><li><a href="#method.set_i64">set_i64</a></li><li><a href="#method.set_multivar">set_multivar</a></li><li><a href="#method.set_str">set_str</a></li><li><a href="#method.snapshot">snapshot</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Drop-for-Config">Drop</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Send-for-Config">!Send</a></li><li><a href="#impl-Sync-for-Config">!Sync</a></li><li><a href="#impl-RefUnwindSafe-for-Config">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-Config">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Config">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></section><h2><a href="index.html">In crate git2</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../git2/all.html" title="show sidebar"></a></div><input class="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"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="index.html">git2</a>::<wbr><a class="struct" href="#">Config</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/git2/config.rs.html#12-14">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Config { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A structure representing a git configuration key/value store</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Config" class="impl"><a class="src rightside" href="../src/git2/config.rs.html#62-500">source</a><a href="#impl-Config" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/git2/config.rs.html#67-74">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Allocate a new configuration object</p>
|
||
<p>This object is empty, so you have to add a file to it before you can do
|
||
anything with it.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.open" class="method"><a class="src rightside" href="../src/git2/config.rs.html#77-86">source</a><h4 class="code-header">pub fn <a href="#method.open" class="fn">open</a>(path: &<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Create a new config instance containing a single on-disk file</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.open_default" class="method"><a class="src rightside" href="../src/git2/config.rs.html#93-100">source</a><h4 class="code-header">pub fn <a href="#method.open_default" class="fn">open_default</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Open the global, XDG and system configuration files</p>
|
||
<p>Utility wrapper that finds the global, XDG and system configuration
|
||
files and opens them into a single prioritized config object that can
|
||
be used when accessing default config data outside a repository.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.find_global" class="method"><a class="src rightside" href="../src/git2/config.rs.html#113-120">source</a><h4 class="code-header">pub fn <a href="#method.find_global" class="fn">find_global</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Locate the path to the global configuration file</p>
|
||
<p>The user or global configuration file is usually located in
|
||
<code>$HOME/.gitconfig</code>.</p>
|
||
<p>This method will try to guess the full path to that file, if the file
|
||
exists. The returned path may be used on any method call to load
|
||
the global configuration file.</p>
|
||
<p>This method will not guess the path to the XDG compatible config file
|
||
(<code>.config/git/config</code>).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.find_system" class="method"><a class="src rightside" href="../src/git2/config.rs.html#125-132">source</a><h4 class="code-header">pub fn <a href="#method.find_system" class="fn">find_system</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Locate the path to the system configuration file</p>
|
||
<p>If /etc/gitconfig doesn’t exist, it will look for <code>%PROGRAMFILES%</code></p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.find_xdg" class="method"><a class="src rightside" href="../src/git2/config.rs.html#138-145">source</a><h4 class="code-header">pub fn <a href="#method.find_xdg" class="fn">find_xdg</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Locate the path to the global XDG compatible configuration file</p>
|
||
<p>The XDG compatible configuration file is usually located in
|
||
<code>$HOME/.config/git/config</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.add_file" class="method"><a class="src rightside" href="../src/git2/config.rs.html#156-169">source</a><h4 class="code-header">pub fn <a href="#method.add_file" class="fn">add_file</a>(
|
||
&mut self,
|
||
path: &<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.Path.html" title="struct std::path::Path">Path</a>,
|
||
level: <a class="enum" href="enum.ConfigLevel.html" title="enum git2::ConfigLevel">ConfigLevel</a>,
|
||
force: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Add an on-disk config file instance to an existing config</p>
|
||
<p>The on-disk file pointed at by path will be opened and parsed; it’s
|
||
expected to be a native Git config file following the default Git config
|
||
syntax (see man git-config).</p>
|
||
<p>Further queries on this config object will access each of the config
|
||
file instances in order (instances with a higher priority level will be
|
||
accessed first).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove" class="method"><a class="src rightside" href="../src/git2/config.rs.html#173-179">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Delete a config variable from the config file with the highest level
|
||
(usually the local one).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove_multivar" class="method"><a class="src rightside" href="../src/git2/config.rs.html#185-192">source</a><h4 class="code-header">pub fn <a href="#method.remove_multivar" class="fn">remove_multivar</a>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, regexp: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Remove multivar config variables in the config file with the highest level (usually the
|
||
local one).</p>
|
||
<p>The regular expression is applied case-sensitively on the value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_bool" class="method"><a class="src rightside" href="../src/git2/config.rs.html#199-206">source</a><h4 class="code-header">pub fn <a href="#method.get_bool" class="fn">get_bool</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Get the value of a boolean config variable.</p>
|
||
<p>All config files will be looked into, in the order of their defined
|
||
level. A higher level means a higher priority. The first occurrence of
|
||
the variable will be returned here.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_i32" class="method"><a class="src rightside" href="../src/git2/config.rs.html#213-220">source</a><h4 class="code-header">pub fn <a href="#method.get_i32" class="fn">get_i32</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i32.html">i32</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Get the value of an integer config variable.</p>
|
||
<p>All config files will be looked into, in the order of their defined
|
||
level. A higher level means a higher priority. The first occurrence of
|
||
the variable will be returned here.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_i64" class="method"><a class="src rightside" href="../src/git2/config.rs.html#227-234">source</a><h4 class="code-header">pub fn <a href="#method.get_i64" class="fn">get_i64</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i64.html">i64</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Get the value of an integer config variable.</p>
|
||
<p>All config files will be looked into, in the order of their defined
|
||
level. A higher level means a higher priority. The first occurrence of
|
||
the variable will be returned here.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_str" class="method"><a class="src rightside" href="../src/git2/config.rs.html#242-245">source</a><h4 class="code-header">pub fn <a href="#method.get_str" class="fn">get_str</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Get the value of a string config variable.</p>
|
||
<p>This is the same as <code>get_bytes</code> except that it may return <code>Err</code> if
|
||
the bytes are not valid utf-8.</p>
|
||
<p>This method will return an error if this <code>Config</code> is not a snapshot.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_bytes" class="method"><a class="src rightside" href="../src/git2/config.rs.html#250-257">source</a><h4 class="code-header">pub fn <a href="#method.get_bytes" class="fn">get_bytes</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>], <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Get the value of a string config variable as a byte slice.</p>
|
||
<p>This method will return an error if this <code>Config</code> is not a snapshot.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_string" class="method"><a class="src rightside" href="../src/git2/config.rs.html#266-275">source</a><h4 class="code-header">pub fn <a href="#method.get_string" class="fn">get_string</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Get the value of a string config variable as an owned string.</p>
|
||
<p>All config files will be looked into, in the order of their
|
||
defined level. A higher level means a higher priority. The
|
||
first occurrence of the variable will be returned here.</p>
|
||
<p>An error will be returned if the config value is not valid utf-8.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_path" class="method"><a class="src rightside" href="../src/git2/config.rs.html#286-293">source</a><h4 class="code-header">pub fn <a href="#method.get_path" class="fn">get_path</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Get the value of a path config variable as an owned <code>PathBuf</code>.</p>
|
||
<p>A leading ‘~’ will be expanded to the global search path (which
|
||
defaults to the user’s home directory but can be overridden via
|
||
<a href="../libgit2_sys/fn.git_libgit2_opts.html" title="fn libgit2_sys::git_libgit2_opts"><code>raw::git_libgit2_opts</code></a>.</p>
|
||
<p>All config files will be looked into, in the order of their
|
||
defined level. A higher level means a higher priority. The
|
||
first occurrence of the variable will be returned here.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_entry" class="method"><a class="src rightside" href="../src/git2/config.rs.html#296-303">source</a><h4 class="code-header">pub fn <a href="#method.get_entry" class="fn">get_entry</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.ConfigEntry.html" title="struct git2::ConfigEntry">ConfigEntry</a><'_>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Get the ConfigEntry for a config variable.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.entries" class="method"><a class="src rightside" href="../src/git2/config.rs.html#330-344">source</a><h4 class="code-header">pub fn <a href="#method.entries" class="fn">entries</a>(&self, glob: <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.ConfigEntries.html" title="struct git2::ConfigEntries">ConfigEntries</a><'_>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Iterate over all the config variables</p>
|
||
<p>If <code>glob</code> is <code>Some</code>, then the iterator will only iterate over all
|
||
variables whose name matches the pattern.</p>
|
||
<p>The regular expression is applied case-sensitively on the normalized form of
|
||
the variable name: the section and variable parts are lower-cased. The
|
||
subsection is left unchanged.</p>
|
||
<p>Due to lifetime restrictions, the returned value does not implement
|
||
the standard <a href="https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator"><code>Iterator</code></a> trait. See <a href="struct.ConfigEntries.html" title="struct git2::ConfigEntries"><code>ConfigEntries</code></a> for more.</p>
|
||
<h5 id="example"><a href="#example">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>git2::Config;
|
||
|
||
<span class="kw">let </span>cfg = Config::new().unwrap();
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>entries = cfg.entries(<span class="prelude-val">None</span>).unwrap();
|
||
<span class="kw">while let </span><span class="prelude-val">Some</span>(entry) = entries.next() {
|
||
<span class="kw">let </span>entry = entry.unwrap();
|
||
<span class="macro">println!</span>(<span class="string">"{} => {}"</span>, entry.name().unwrap(), entry.value().unwrap());
|
||
}</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.multivar" class="method"><a class="src rightside" href="../src/git2/config.rs.html#357-367">source</a><h4 class="code-header">pub fn <a href="#method.multivar" class="fn">multivar</a>(
|
||
&self,
|
||
name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>,
|
||
regexp: <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.ConfigEntries.html" title="struct git2::ConfigEntries">ConfigEntries</a><'_>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Iterate over the values of a multivar</p>
|
||
<p>If <code>regexp</code> is <code>Some</code>, then the iterator will only iterate over all
|
||
values which match the pattern.</p>
|
||
<p>The regular expression is applied case-sensitively on the normalized form of
|
||
the variable name: the section and variable parts are lower-cased. The
|
||
subsection is left unchanged.</p>
|
||
<p>Due to lifetime restrictions, the returned value does not implement
|
||
the standard <a href="https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator"><code>Iterator</code></a> trait. See <a href="struct.ConfigEntries.html" title="struct git2::ConfigEntries"><code>ConfigEntries</code></a> for more.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.open_global" class="method"><a class="src rightside" href="../src/git2/config.rs.html#375-381">source</a><h4 class="code-header">pub fn <a href="#method.open_global" class="fn">open_global</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Open the global/XDG configuration file according to git’s rules</p>
|
||
<p>Git allows you to store your global configuration at <code>$HOME/.config</code> or
|
||
<code>$XDG_CONFIG_HOME/git/config</code>. For backwards compatibility, the XDG file
|
||
shouldn’t be used unless the use has created it explicitly. With this
|
||
function you’ll open the correct one to write to.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.open_level" class="method"><a class="src rightside" href="../src/git2/config.rs.html#387-393">source</a><h4 class="code-header">pub fn <a href="#method.open_level" class="fn">open_level</a>(&self, level: <a class="enum" href="enum.ConfigLevel.html" title="enum git2::ConfigLevel">ConfigLevel</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Build a single-level focused config object from a multi-level one.</p>
|
||
<p>The returned config object can be used to perform get/set/delete
|
||
operations on a single specific level.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_bool" class="method"><a class="src rightside" href="../src/git2/config.rs.html#397-403">source</a><h4 class="code-header">pub fn <a href="#method.set_bool" class="fn">set_bool</a>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, value: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Set the value of a boolean config variable in the config file with the
|
||
highest level (usually the local one).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_i32" class="method"><a class="src rightside" href="../src/git2/config.rs.html#407-413">source</a><h4 class="code-header">pub fn <a href="#method.set_i32" class="fn">set_i32</a>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, value: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i32.html">i32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Set the value of an integer config variable in the config file with the
|
||
highest level (usually the local one).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_i64" class="method"><a class="src rightside" href="../src/git2/config.rs.html#417-423">source</a><h4 class="code-header">pub fn <a href="#method.set_i64" class="fn">set_i64</a>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, value: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i64.html">i64</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Set the value of an integer config variable in the config file with the
|
||
highest level (usually the local one).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_multivar" class="method"><a class="src rightside" href="../src/git2/config.rs.html#429-437">source</a><h4 class="code-header">pub fn <a href="#method.set_multivar" class="fn">set_multivar</a>(
|
||
&mut self,
|
||
name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>,
|
||
regexp: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>,
|
||
value: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Set the value of an multivar config variable in the config file with the
|
||
highest level (usually the local one).</p>
|
||
<p>The regular expression is applied case-sensitively on the value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_str" class="method"><a class="src rightside" href="../src/git2/config.rs.html#441-448">source</a><h4 class="code-header">pub fn <a href="#method.set_str" class="fn">set_str</a>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>, value: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Set the value of a string config variable in the config file with the
|
||
highest level (usually the local one).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.snapshot" class="method"><a class="src rightside" href="../src/git2/config.rs.html#455-461">source</a><h4 class="code-header">pub fn <a href="#method.snapshot" class="fn">snapshot</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Create a snapshot of the configuration</p>
|
||
<p>Create a snapshot of the current state of a configuration, which allows
|
||
you to look into a consistent view of the configuration for looking up
|
||
complex values (e.g. a remote, submodule).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.parse_bool" class="method"><a class="src rightside" href="../src/git2/config.rs.html#467-475">source</a><h4 class="code-header">pub fn <a href="#method.parse_bool" class="fn">parse_bool</a><S: <a class="trait" href="trait.IntoCString.html" title="trait git2::IntoCString">IntoCString</a>>(s: S) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Parse a string as a bool.</p>
|
||
<p>Interprets “true”, “yes”, “on”, 1, or any non-zero number as true.
|
||
Interprets “false”, “no”, “off”, 0, or an empty string as false.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.parse_i32" class="method"><a class="src rightside" href="../src/git2/config.rs.html#479-487">source</a><h4 class="code-header">pub fn <a href="#method.parse_i32" class="fn">parse_i32</a><S: <a class="trait" href="trait.IntoCString.html" title="trait git2::IntoCString">IntoCString</a>>(s: S) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i32.html">i32</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Parse a string as an i32; handles suffixes like k, M, or G, and
|
||
multiplies by the appropriate power of 1024.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.parse_i64" class="method"><a class="src rightside" href="../src/git2/config.rs.html#491-499">source</a><h4 class="code-header">pub fn <a href="#method.parse_i64" class="fn">parse_i64</a><S: <a class="trait" href="trait.IntoCString.html" title="trait git2::IntoCString">IntoCString</a>>(s: S) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.i64.html">i64</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>></h4></section></summary><div class="docblock"><p>Parse a string as an i64; handles suffixes like k, M, or G, and
|
||
multiplies by the appropriate power of 1024.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Drop-for-Config" class="impl"><a class="src rightside" href="../src/git2/config.rs.html#512-516">source</a><a href="#impl-Drop-for-Config" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../src/git2/config.rs.html#513-515">source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.76.0/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Config" class="impl"><a href="#impl-RefUnwindSafe-for-Config" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a></h3></section><section id="impl-Send-for-Config" class="impl"><a href="#impl-Send-for-Config" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a></h3></section><section id="impl-Sync-for-Config" class="impl"><a href="#impl-Sync-for-Config" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a></h3></section><section id="impl-Unpin-for-Config" class="impl"><a href="#impl-Unpin-for-Config" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a></h3></section><section id="impl-UnwindSafe-for-Config" class="impl"><a href="#impl-UnwindSafe-for-Config" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Config.html" title="struct git2::Config">Config</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#763">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#766">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#747-749">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#756">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.76.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><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#803-805">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#788-790">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |