<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A structure to represent a git submodule"><title>Submodule in git2 - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="rustdoc-vars"data-root-path="../"data-static-root-path="../static.files/"data-current-crate="git2"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.0 (aedd173a2 2024-03-17)"data-channel="1.77.0"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../git2/index.html">git2</a><spanclass="version">0.18.2</span></h2></div><h2class="location"><ahref="#">Submodule</a></h2><divclass="sidebar-elems"><section><h3><ahref="#implementations">Methods</a></h3><ulclass="block method"><li><ahref="#method.add_finalize">add_finalize</a></li><li><ahref="#method.add_to_index">add_to_index</a></li><li><ahref="#method.branch">branch</a></li><li><ahref="#method.branch_bytes">branch_bytes</a></li><li><ahref="#method.clone">clone</a></li><li><ahref="#method.head_id">head_id</a></li><li><ahref="#method.ignore_rule">ignore_rule</a></li><li><ahref="#method.index_id">index_id</a></li><li><ahref="#method.init">init</a></li><li><ahref="#method.name">name</a></li><li><ahref="#method.name_bytes">name_bytes</a></li><li><ahref="#method.open">open</a></li><li><ahref="#method.opt_url_bytes">opt_url_bytes</a></li><li><ahref="#method.path">path</a></li><li><ahref="#method.reload">reload</a></li><li><ahref="#method.repo_init">repo_init</a></li><li><ahref="#method.sync">sync</a></li><li><ahref="#method.update">update</a></li><li><ahref="#method.update_strategy">update_strategy</a></li><li><ahref="#method.url">url</a></li><li><ahref="#method.workdir_id">workdir_id</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block trait-implementation"><li><ahref="#impl-Drop-for-Submodule%3C'repo%3E">Drop</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block synthetic-implementation"><li><ahref="#impl-Send-for-Submodule%3C'repo%3E">!Send</a></li><li><ahref="#impl-Sync-for-Submodule%3C'repo%3E">!Sync</a></li><li><ahref="#impl-RefUnwindSafe-for-Submodule%3C'repo%3E">RefUnwindSafe</a></li><li><ahref="#impl-Unpin-for-Submodule%3C'repo%3E">U
<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="#">Submodule</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/submodule.rs.html#15-18">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct Submodule<'repo> { <spanclass="comment">/* private fields */</span> }</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A structure to represent a git <ahref="http://git-scm.com/book/en/Git-Tools-Submodules">submodule</a></p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.branch_bytes"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#32-34">source</a><h4class="code-header">pub fn <ahref="#method.branch_bytes"class="fn">branch_bytes</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&[<aclass="primitive"href="https://doc.rust-lang.org/1.77.0/std/primitive.u8.html">u8</a>]></h4></section></summary><divclass="docblock"><p>Get the branch for the submodule.</p>
) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.Repository.html"title="struct git2::Repository">Repository</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Perform the clone step for a newly created submodule.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.opt_url_bytes"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#74-76">source</a><h4class="code-header">pub fn <ahref="#method.opt_url_bytes"class="fn">opt_url_bytes</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&[<aclass="primitive"href="https://doc.rust-lang.org/1.77.0/std/primitive.u8.html">u8</a>]></h4></section></summary><divclass="docblock"><p>Get the URL for the submodule.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.name_bytes"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#86-88">source</a><h4class="code-header">pub fn <ahref="#method.name_bytes"class="fn">name_bytes</a>(&self) ->&[<aclass="primitive"href="https://doc.rust-lang.org/1.77.0/std/primitive.u8.html">u8</a>] <ahref="#"class="tooltip"data-notable-ty="&[u8]">ⓘ</a></h4></section></summary><divclass="docblock"><p>Get the name for the submodule.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.path"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#91-95">source</a><h4class="code-header">pub fn <ahref="#method.path"class="fn">path</a>(&self) ->&<aclass="struct"href="https://doc.rust-lang.org/1.77.0/std/path/struct.Path.html"title="struct std::path::Path">Path</a></h4></section></summary><divclass="docblock"><p>Get the path for the submodule.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.head_id"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#98-100">source</a><h4class="code-header">pub fn <ahref="#method.head_id"class="fn">head_id</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="struct.Oid.html"title="struct git2::Oid">Oid</a>></h4></section></summary><divclass="docblock"><p>Get the OID for the submodule in the current HEAD tree.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.index_id"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#103-105">source</a><h4class="code-header">pub fn <ahref="#method.index_id"class="fn">index_id</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="struct.Oid.html"title="struct git2::Oid">Oid</a>></h4></section></summary><divclass="docblock"><p>Get the OID for the submodule in the index.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.workdir_id"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#112-114">source</a><h4class="code-header">pub fn <ahref="#method.workdir_id"class="fn">workdir_id</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="struct.Oid.html"title="struct git2::Oid">Oid</a>></h4></section></summary><divclass="docblock"><p>Get the OID for the submodule in the current working directory.</p>
<p>This returns the OID that corresponds to looking up ‘HEAD’ in the
checked out submodule. If there are pending changes in the index or
anything else, this won’t notice that.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.ignore_rule"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#117-119">source</a><h4class="code-header">pub fn <ahref="#method.ignore_rule"class="fn">ignore_rule</a>(&self) -><aclass="enum"href="enum.SubmoduleIgnore.html"title="enum git2::SubmoduleIgnore">SubmoduleIgnore</a></h4></section></summary><divclass="docblock"><p>Get the ignore rule that will be used for the submodule.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.update_strategy"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#122-124">source</a><h4class="code-header">pub fn <ahref="#method.update_strategy"class="fn">update_strategy</a>(&self) -><aclass="enum"href="enum.SubmoduleUpdate.html"title="enum git2::SubmoduleUpdate">SubmoduleUpdate</a></h4></section></summary><divclass="docblock"><p>Get the update rule that will be used for the submodule.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.repo_init"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#149-159">source</a><h4class="code-header">pub fn <ahref="#method.repo_init"class="fn">repo_init</a>(&mut self, use_gitlink: <aclass="primitive"href="https://doc.rust-lang.org/1.77.0/std/primitive.bool.html">bool</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.Repository.html"title="struct git2::Repository">Repository</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Set up the subrepository for a submodule in preparation for clone.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.open"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#165-171">source</a><h4class="code-header">pub fn <ahref="#method.open"class="fn">open</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.Repository.html"title="struct git2::Repository">Repository</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Open the repository for a submodule.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.add_to_index"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#205-210">source</a><h4class="code-header">pub fn <ahref="#method.add_to_index"class="fn">add_to_index</a>(&mut self, write_index: <aclass="primitive"href="https://doc.rust-lang.org/1.77.0/std/primitive.bool.html">bool</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.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 current submodule HEAD commit to index of superproject.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.add_finalize"class="method"><aclass="src rightside"href="../src/git2/submodule.rs.html#218-223">source</a><h4class="code-header">pub fn <ahref="#method.add_finalize"class="fn">add_finalize</a>(&mut self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.0/std/primitive.unit.html">()</a>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Resolve the setup of a new git submodule.</p>
<code><ahref="https://doc.rust-lang.org/1.77.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.77.0/src/core/convert/mod.rs.html#804-806">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.77.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.77.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.77.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.77.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.77.0/src/core/convert/mod.rs.html#811">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.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.77.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.77.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.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.77.0/src/core/convert/mod.rs.html#789-791">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.77.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.77.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.77.0/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.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.77.0/src/core/convert/mod.rs.html#796">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.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.77.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.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><scripttype="text/json"id="notable-traits-data">{"&[u8]":"<h3>Notable traits for <code>&[<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.77.0/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/1.77.0/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &[<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.77.0/std/primitive.u8.html\">u8</a>]</div>"}</script></section></div></main></body></html>