<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="#">Tree</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/tree.rs.html#18-21">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct Tree<'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-Internals-Git-Objects">tree</a></p>
</div></details><h2id="implementations"class="section-header">Implementations<ahref="#implementations"class="anchor">§</a></h2><divid="implementations-list"><detailsclass="toggle implementors-toggle"open><summary><sectionid="impl-Tree%3C'repo%3E"class="impl"><aclass="src rightside"href="../src/git2/tree.rs.html#74-204">source</a><ahref="#impl-Tree%3C'repo%3E"class="anchor">§</a><h3class="code-header">impl<'repo><aclass="struct"href="struct.Tree.html"title="struct git2::Tree">Tree</a><'repo></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.id"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#76-78">source</a><h4class="code-header">pub fn <ahref="#method.id"class="fn">id</a>(&self) -><aclass="struct"href="struct.Oid.html"title="struct git2::Oid">Oid</a></h4></section></summary><divclass="docblock"><p>Get the id (SHA1) of a repository object</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.len"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#81-83">source</a><h4class="code-header">pub fn <ahref="#method.len"class="fn">len</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.usize.html">usize</a></h4></section></summary><divclass="docblock"><p>Get the number of entries listed in this tree.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.is_empty"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#86-88">source</a><h4class="code-header">pub fn <ahref="#method.is_empty"class="fn">is_empty</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.bool.html">bool</a></h4></section></summary><divclass="docblock"><p>Return <code>true</code> if there is not entry</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.iter"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#91-96">source</a><h4class="code-header">pub fn <ahref="#method.iter"class="fn">iter</a>(&self) -><aclass="struct"href="struct.TreeIter.html"title="struct git2::TreeIter">TreeIter</a><'_><ahref="#"class="tooltip"data-notable-ty="TreeIter<'_>">ⓘ</a></h4></section></summary><divclass="docblock"><p>Returns an iterator over the entries in this tree.</p>
T: <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.i32.html">i32</a>>,</div></h4></section></summary><divclass="docblock"><p>Traverse the entries in a tree and its subtrees in post or pre-order.
The callback function will be run on each node of the tree that’s
walked. The return code of this function will determine how the walk
continues.</p>
<p>libgit2 requires that the callback be an integer, where 0 indicates a
successful visit, 1 skips the node, and -1 aborts the traversal completely.
You may opt to use the enum <ahref="enum.TreeWalkResult.html"title="enum git2::TreeWalkResult"><code>TreeWalkResult</code></a> instead.</p>
<divclass="example-wrap ignore"><ahref="#"class="tooltip"title="This example is not tested">ⓘ</a><preclass="rust rust-example-rendered"><code><spanclass="kw">let </span><spanclass="kw-2">mut </span>ct = <spanclass="number">0</span>;
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_id"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#140-149">source</a><h4class="code-header">pub fn <ahref="#method.get_id"class="fn">get_id</a>(&self, id: <aclass="struct"href="struct.Oid.html"title="struct git2::Oid">Oid</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="struct.TreeEntry.html"title="struct git2::TreeEntry">TreeEntry</a><'_>></h4></section></summary><divclass="docblock"><p>Lookup a tree entry by SHA value.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#152-161">source</a><h4class="code-header">pub fn <ahref="#method.get"class="fn">get</a>(&self, n: <aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.usize.html">usize</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="struct.TreeEntry.html"title="struct git2::TreeEntry">TreeEntry</a><'_>></h4></section></summary><divclass="docblock"><p>Lookup a tree entry by its position in the tree</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_name"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#164-166">source</a><h4class="code-header">pub fn <ahref="#method.get_name"class="fn">get_name</a>(&self, filename: &<aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.str.html">str</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="struct.TreeEntry.html"title="struct git2::TreeEntry">TreeEntry</a><'_>></h4></section></summary><divclass="docblock"><p>Lookup a tree entry by its filename</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_name_bytes"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#171-181">source</a><h4class="code-header">pub fn <ahref="#method.get_name_bytes"class="fn">get_name_bytes</a>(&self, filename: &[<aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.u8.html">u8</a>]) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="struct.TreeEntry.html"title="struct git2::TreeEntry">TreeEntry</a><'_>></h4></section></summary><divclass="docblock"><p>Lookup a tree entry by its filename, specified as bytes.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.get_path"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#185-192">source</a><h4class="code-header">pub fn <ahref="#method.get_path"class="fn">get_path</a>(&self, path: &<aclass="struct"href="https://doc.rust-lang.org/1.77.2/std/path/struct.Path.html"title="struct std::path::Path">Path</a>) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.TreeEntry.html"title="struct git2::TreeEntry">TreeEntry</a><'static>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Retrieve a tree entry contained in a tree or in any of its subtrees,
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.as_object"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#195-197">source</a><h4class="code-header">pub fn <ahref="#method.as_object"class="fn">as_object</a>(&self) ->&<aclass="struct"href="struct.Object.html"title="struct git2::Object">Object</a><'repo></h4></section></summary><divclass="docblock"><p>Casts this Tree to be usable as an <code>Object</code></p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.into_object"class="method"><aclass="src rightside"href="../src/git2/tree.rs.html#200-203">source</a><h4class="code-header">pub fn <ahref="#method.into_object"class="fn">into_object</a>(self) -><aclass="struct"href="struct.Object.html"title="struct git2::Object">Object</a><'repo></h4></section></summary><divclass="docblock"><p>Consumes this Tree to be returned as an <code>Object</code></p>
<code><ahref="https://doc.rust-lang.org/1.77.2/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-ToOwned-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/alloc/borrow.rs.html#83-85">source</a><ahref="#impl-ToOwned-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.77.2/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T<divclass="where">where
T: <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Owned"class="associatedtype trait-impl"><ahref="#associatedtype.Owned"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.2/alloc/borrow/trait.ToOwned.html#associatedtype.Owned"class="associatedtype">Owned</a> = T</h4></section></summary><divclass='docblock'>The resulting type after obtaining ownership.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.to_owned"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/alloc/borrow.rs.html#88">source</a><ahref="#method.to_owned"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/alloc/borrow/trait.ToOwned.html#tymethod.to_owned"class="fn">to_owned</a>(&self) -> T</h4></section></summary><divclass='docblock'>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/1.77.2/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.clone_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.2/src/alloc/borrow.rs.html#92">source</a><ahref="#method.clone_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.2/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fn">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/1.77.2/std/primitive.reference.html">&mut T</a>)</h4></section></summary><divclass='docblock'>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/1.77.2/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></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.2/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.2/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.2/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.2/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.77.2/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.2/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.2/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.2/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.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.2/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.2/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.2/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.2/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.2/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.2/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.2/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.2/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.2/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.2/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.2/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">{"TreeIter<'_>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.TreeIter.html\" title=\"struct git2::TreeIter\">TreeIter</a><'tree></code></h3><pre><code><div class=\"where\">impl<'tree> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.77.2/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.TreeIter.html\" title=\"struct git2::TreeIter\">TreeIter</a><'tree></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.77.2/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"struct\" href=\"struct.TreeEntry.html\" title=\"struct git2::TreeEntry\">TreeEntry</a><'tree>;</div>"}</script></section></div></main></body></html>
