<!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 tag"><title>Tag in git2 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)"data-channel="1.80.0"data-search-js="search-d52510db62a78183.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../static.files/storage-118b08c4c78b968e.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-20a3ad099b048cf2.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-df360f571f6edeae.css"></noscript><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.3</span></h2></div><h2class="location"><ahref="#">Tag</a></h2><divclass="sidebar-elems"><section><h3><ahref="#implementations">Methods</a></h3><ulclass="block method"><li><ahref="#method.as_object">as_object</a></li><li><ahref="#method.id">id</a></li><li><ahref="#method.into_object">into_object</a></li><li><ahref="#method.is_valid_name">is_valid_name</a></li><li><ahref="#method.message">message</a></li><li><ahref="#method.message_bytes">message_bytes</a></li><li><ahref="#method.name">name</a></li><li><ahref="#method.name_bytes">name_bytes</a></li><li><ahref="#method.peel">peel</a></li><li><ahref="#method.tagger">tagger</a></li><li><ahref="#method.target">target</a></li><li><ahref="#method.target_id">target_id</a></li><li><ahref="#method.target_type">target_type</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block trait-implementation"><li><ahref="#impl-Clone-for-Tag%3C'repo%3E">Clone</a></li><li><ahref="#impl-Debug-for-Tag%3C'repo%3E">Debug</a></li><li><ahref="#impl-Drop-for-Tag%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-Tag%3C'repo%3E">!Send</a></li><li><ahref="#impl-Sync-for-Tag%3C'repo%3E">!Sync</a></li><li><ahref="#impl-Freeze-for-Tag%3C'repo%3E">Freeze</a></li><li><ahref="#impl-RefUnwindSafe-for-Tag%3C'repo%3E">RefUnwindSafe</a></li><li><ahref="#impl-Unpin-for-Tag%3C'repo%3E">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-Tag%3C'repo%3E">UnwindSafe</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block blanket-implementation"><li><ahref="#impl-Any-for-T">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><ahref="#impl-From%3CT%3E-for-T">From<T></a></li><li><ahref="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><ahref="#impl-ToOwned-for-T">ToOwned</a><
</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-Tag%3C'repo%3E"class="impl"><aclass="src rightside"href="../src/git2/tag.rs.html#18-118">source</a><ahref="#impl-Tag%3C'repo%3E"class="anchor">§</a><h3class="code-header">impl<'repo><aclass="struct"href="struct.Tag.html"title="struct git2::Tag">Tag</a><'repo></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.is_valid_name"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#22-30">source</a><h4class="code-header">pub fn <ahref="#method.is_valid_name"class="fn">is_valid_name</a>(tag_name: &<aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>) -><aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><divclass="docblock"><p>Determine whether a tag name is valid, meaning that (when prefixed with refs/tags/) that
it is a valid reference name, and that any additional tag name restrictions are imposed
(eg, it cannot start with a -).</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.id"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#33-35">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 tag</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.message"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#40-42">source</a><h4class="code-header">pub fn <ahref="#method.message"class="fn">message</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Get the message of a tag</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.message_bytes"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#47-49">source</a><h4class="code-header">pub fn <ahref="#method.message_bytes"class="fn">message_bytes</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&[<aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>]></h4></section></summary><divclass="docblock"><p>Get the message of a tag</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.name"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#54-56">source</a><h4class="code-header">pub fn <ahref="#method.name"class="fn">name</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&<aclass="primitive"href="https://doc.rust-lang.org/1.80.0/std/primitive.str.html">str</a>></h4></section></summary><divclass="docblock"><p>Get the name of a tag</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.name_bytes"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#59-61">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.80.0/std/primitive.u8.html">u8</a>] <ahref="#"class="tooltip"data-notable-ty="&[u8]">ⓘ</a></h4></section></summary><divclass="docblock"><p>Get the name of a tag</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.peel"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#64-70">source</a><h4class="code-header">pub fn <ahref="#method.peel"class="fn">peel</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.Object.html"title="struct git2::Object">Object</a><'repo>, <aclass="struct"href="struct.Error.html"title="struct git2::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Recursively peel a tag until a non tag git_object is found</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.tagger"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#75-84">source</a><h4class="code-header">pub fn <ahref="#method.tagger"class="fn">tagger</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="struct.Signature.html"title="struct git2::Signature">Signature</a><'_>></h4></section></summary><divclass="docblock"><p>Get the tagger (author) of a tag</p>
<p>This method performs a repository lookup for the given object and
returns it</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.target_id"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#99-101">source</a><h4class="code-header">pub fn <ahref="#method.target_id"class="fn">target_id</a>(&self) -><aclass="struct"href="struct.Oid.html"title="struct git2::Oid">Oid</a></h4></section></summary><divclass="docblock"><p>Get the OID of the tagged object of a tag</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.target_type"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#104-106">source</a><h4class="code-header">pub fn <ahref="#method.target_type"class="fn">target_type</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="enum"href="enum.ObjectType.html"title="enum git2::ObjectType">ObjectType</a>></h4></section></summary><divclass="docblock"><p>Get the ObjectType of the tagged object of a tag</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.as_object"class="method"><aclass="src rightside"href="../src/git2/tag.rs.html#109-111">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 Tag 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/tag.rs.html#114-117">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 Tag to be returned as an <code>Object</code></p>
<code><ahref="https://doc.rust-lang.org/1.80.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-ToOwned-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/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.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fn">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/1.80.0/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.80.0/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.80.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.80.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.80.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"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.80.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.80.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.80.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.80.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.80.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.80.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.80.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.80.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.80.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-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.80.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.80.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.80.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.80.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.80.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.80.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.80.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.80.0/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &[<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.80.0/std/primitive.u8.html\">u8</a>]</div>"}</script></section></div></main></body></html>
