rtic/stable/api/syn/meta/struct.ParseNestedMeta.html

173 lines
33 KiB
HTML
Raw Permalink Normal View History

<!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="Context for parsing a single property in the conventional syntax for structured attributes."><title>ParseNestedMeta in syn::meta - 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><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="syn" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../syn/index.html">syn</a><span class="version">2.0.90</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Parse<wbr>Nested<wbr>Meta</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#fields">Fields</a></h3><ul class="block structfield"><li><a href="#structfield.input" title="input">input</a></li><li><a href="#structfield.path" title="path">path</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.error" title="error">error</a></li><li><a href="#method.parse_nested_meta" title="parse_nested_meta">parse_nested_meta</a></li><li><a href="#method.value" title="value">value</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Send-for-ParseNestedMeta%3C'a%3E" title="!Send">!Send</a></li><li><a href="#impl-Sync-for-ParseNestedMeta%3C'a%3E" title="!Sync">!Sync</a></li><li><a href="#impl-Freeze-for-ParseNestedMeta%3C'a%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ParseNestedMeta%3C'a%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-ParseNestedMeta%3C'a%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ParseNestedMeta%3C'a%3E" title="UnwindSafe">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" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-TryF
pub path: <a class="struct" href="../struct.Path.html" title="struct syn::Path">Path</a>,
pub input: <a class="type" href="../parse/type.ParseStream.html" title="type syn::parse::ParseStream">ParseStream</a>&lt;'a&gt;,
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Context for parsing a single property in the conventional syntax for
structured attributes.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<p>Refer to usage examples on the following two entry-points:</p>
<ul>
<li>
<p><a href="../struct.Attribute.html#method.parse_nested_meta" title="method syn::Attribute::parse_nested_meta"><code>Attribute::parse_nested_meta</code></a> if you have an entire <code>Attribute</code> to
parse. Always use this if possible. Generally this is able to produce
better error messages because <code>Attribute</code> holds span information for all
of the delimiters therein.</p>
</li>
<li>
<p><a href="fn.parser.html" title="fn syn::meta::parser"><code>syn::meta::parser</code></a> if you are implementing a <code>proc_macro_attribute</code>
macro and parsing the arguments to the attribute macro, i.e. the ones
written in the same attribute that dispatched the macro invocation. Rustc
does not pass span information for the surrounding delimiters into the
attribute macro invocation in this situation, so error messages might be
less precise.</p>
</li>
</ul>
</div></details><h2 id="fields" class="fields section-header">Fields (Non-exhaustive)<a href="#fields" class="anchor">§</a></h2><details class="toggle non-exhaustive"><summary class="hideme"><span>This struct is marked as non-exhaustive</span></summary><div class="docblock">Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional <code>Struct { .. }</code> syntax; cannot be matched against without a wildcard <code>..</code>; and struct update syntax will not work.</div></details><span id="structfield.path" class="structfield section-header"><a href="#structfield.path" class="anchor field">§</a><code>path: <a class="struct" href="../struct.Path.html" title="struct syn::Path">Path</a></code></span><span id="structfield.input" class="structfield section-header"><a href="#structfield.input" class="anchor field">§</a><code>input: <a class="type" href="../parse/type.ParseStream.html" title="type syn::parse::ParseStream">ParseStream</a>&lt;'a&gt;</code></span><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-ParseNestedMeta%3C'a%3E" class="impl"><a class="src rightside" href="../../src/syn/meta.rs.html#169-383">source</a><a href="#impl-ParseNestedMeta%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="struct" href="struct.ParseNestedMeta.html" title="struct syn::meta::ParseNestedMeta">ParseNestedMeta</a>&lt;'a&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.value" class="method"><a class="src rightside" href="../../src/syn/meta.rs.html#202-205">source</a><h4 class="code-header">pub fn <a href="#method.value" class="fn">value</a>(&amp;self) -&gt; <a class="type" href="../parse/type.Result.html" title="type syn::parse::Result">Result</a>&lt;<a class="type" href="../parse/type.ParseStream.html" title="type syn::parse::ParseStream">ParseStream</a>&lt;'a&gt;&gt;</h4></section></summary><div class="docblock"><p>Used when parsing <code>key = "value"</code> syntax.</p>
<p>All it does is advance <code>meta.input</code> past the <code>=</code> sign in the input. You
could accomplish the same effect by writing
<code>meta.parse::&lt;Token![=]&gt;()?</code>, so at most it is a minor convenience to
use <code>meta.value()?</code>.</p>
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>syn::{parse_quote, Attribute, LitStr};
<span class="kw">let </span>attr: Attribute = <span class="macro">parse_quote!</span> {
<span class="attr">#[tea(kind = <span class="string">"EarlGrey"</span>)]
</span>};
<span class="comment">// conceptually:
</span><span class="kw">if </span>attr.path().is_ident(<span class="string">"tea"</span>) { <span class="comment">// this parses the `tea`
</span>attr.parse_nested_meta(|meta| { <span class="comment">// this parses the `(`
</span><span class="kw">if </span>meta.path.is_ident(<span class="string">"kind"</span>) { <span class="comment">// this parses the `kind`
</span><span class="kw">let </span>value = meta.value()<span class="question-mark">?</span>; <span class="comment">// this parses the `=`
</span><span class="kw">let </span>s: LitStr = value.parse()<span class="question-mark">?</span>; <span class="comment">// this parses `"EarlGrey"`
</span><span class="kw">if </span>s.value() == <span class="string">"EarlGrey" </span>{
<span class="comment">// ...
</span>}
<span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(meta.error(<span class="string">"unsupported attribute"</span>))
}
})<span class="question-mark">?</span>;
}</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.parse_nested_meta" class="method"><a class="src rightside" href="../../src/syn/meta.rs.html#271-278">source</a><h4 class="code-header">pub fn <a href="#method.parse_nested_meta" class="fn">parse_nested_meta</a>(
&amp;self,
logic: impl <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="struct.ParseNestedMeta.html" title="struct syn::meta::ParseNestedMeta">ParseNestedMeta</a>&lt;'_&gt;) -&gt; <a class="type" href="../parse/type.Result.html" title="type syn::parse::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.unit.html">()</a>&gt;,
) -&gt; <a class="type" href="../parse/type.Result.html" title="type syn::parse::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.unit.html">()</a>&gt;</h4></section></summary><div class="docblock"><p>Used when parsing <code>list(...)</code> syntax <strong>if</strong> the content inside the
nested parentheses is also expected to conform to Rusts structured
attribute convention.</p>
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>syn::{parse_quote, Attribute};
<span class="kw">let </span>attr: Attribute = <span class="macro">parse_quote!</span> {
<span class="attr">#[tea(with(sugar, milk))]
</span>};
<span class="kw">if </span>attr.path().is_ident(<span class="string">"tea"</span>) {
attr.parse_nested_meta(|meta| {
<span class="kw">if </span>meta.path.is_ident(<span class="string">"with"</span>) {
meta.parse_nested_meta(|meta| { <span class="comment">// &lt;---
</span><span class="kw">if </span>meta.path.is_ident(<span class="string">"sugar"</span>) {
<span class="comment">// Here we can go even deeper if needed.
</span><span class="prelude-val">Ok</span>(())
} <span class="kw">else if </span>meta.path.is_ident(<span class="string">"milk"</span>) {
<span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(meta.error(<span class="string">"unsupported ingredient"</span>))
}
})
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(meta.error(<span class="string">"unsupported tea property"</span>))
}
})<span class="question-mark">?</span>;
}</code></pre></div>
<h5 id="counterexample"><a class="doc-anchor" href="#counterexample">§</a>Counterexample</h5>
<p>If you dont need <code>parse_nested_meta</code>s help in parsing the content
written within the nested parentheses, keep in mind that you can always
just parse it yourself from the exposed ParseStream. Rust syntax permits
arbitrary tokens within those parentheses so for the crazier stuff,
<code>parse_nested_meta</code> is not what you want.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>syn::{parenthesized, parse_quote, Attribute, LitInt};
<span class="kw">let </span>attr: Attribute = <span class="macro">parse_quote!</span> {
<span class="attr">#[repr(align(<span class="number">32</span>))]
</span>};
<span class="kw">let </span><span class="kw-2">mut </span>align: <span class="prelude-ty">Option</span>&lt;LitInt&gt; = <span class="prelude-val">None</span>;
<span class="kw">if </span>attr.path().is_ident(<span class="string">"repr"</span>) {
attr.parse_nested_meta(|meta| {
<span class="kw">if </span>meta.path.is_ident(<span class="string">"align"</span>) {
<span class="kw">let </span>content;
<span class="macro">parenthesized!</span>(content <span class="kw">in </span>meta.input);
align = <span class="prelude-val">Some</span>(content.parse()<span class="question-mark">?</span>);
<span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(meta.error(<span class="string">"unsupported repr"</span>))
}
})<span class="question-mark">?</span>;
}</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.error" class="method"><a class="src rightside" href="../../src/syn/meta.rs.html#378-382">source</a><h4 class="code-header">pub fn <a href="#method.error" class="fn">error</a>(&amp;self, msg: impl <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>) -&gt; <a class="struct" href="../parse/struct.Error.html" title="struct syn::parse::Error">Error</a></h4></section></summary><div class="docblock"><p>Report that the attributes content did not conform to expectations.</p>
<p>The span of the resulting error will cover <code>meta.path</code> <em>and</em> everything
that has been parsed so far since it.</p>
<p>There are 2 ways you might call this. First, if <code>meta.path</code> is not
something you recognize:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>attr.parse_nested_meta(|meta| {
<span class="kw">if </span>meta.path.is_ident(<span class="string">"kind"</span>) {
<span class="comment">// ...
</span><span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(meta.error(<span class="string">"unsupported tea property"</span>))
}
})<span class="question-mark">?</span>;</code></pre></div>
<p>In this case, it behaves exactly like
<code>syn::Error::new_spanned(&amp;meta.path, "message...")</code>.</p>
<div class="example-wrap"><pre class="language-console"><code>error: unsupported tea property
--&gt; src/main.rs:3:26
|
3 | #[tea(kind = &quot;EarlGrey&quot;, wat = &quot;foo&quot;)]
| ^^^</code></pre></div>
<p>More usefully, the second place is if youve already parsed a value but
have decided not to accept the value:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>syn::Expr;
attr.parse_nested_meta(|meta| {
<span class="kw">if </span>meta.path.is_ident(<span class="string">"kind"</span>) {
<span class="kw">let </span>expr: Expr = meta.value()<span class="question-mark">?</span>.parse()<span class="question-mark">?</span>;
<span class="kw">match </span>expr {
Expr::Lit(expr) =&gt; <span class="comment">/* ... */
</span>Expr::Path(expr) =&gt; <span class="comment">/* ... */
</span>Expr::Macro(expr) =&gt; <span class="comment">/* ... */
</span><span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(meta.error(<span class="string">"tea kind must be a string literal, path, or macro"</span>)),
}
} <span class="kw">else </span><span class="comment">/* as above */
</span>})<span class="question-mark">?</span>;</code></pre></div>
<div class="example-wrap"><pre class="language-console"><code>error: tea kind must be a string literal, path, or macro
--&gt; src/main.rs:3:7
|
3 | #[tea(kind = async { replicator.await })]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^</code></pre></div>
<p>Often you may want to use <code>syn::Error::new_spanned</code> even in this
situation. In the above code, that would be:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code> <span class="kw">match </span>expr {
Expr::Lit(expr) =&gt; <span class="comment">/* ... */
</span>Expr::Path(expr) =&gt; <span class="comment">/* ... */
</span>Expr::Macro(expr) =&gt; <span class="comment">/* ... */
</span><span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(Error::new_spanned(expr, <span class="string">"unsupported expression type for `kind`"</span>)),
}</code></pre></div>
<div class="example-wrap"><pre class="language-console"><code>error: unsupported expression type for `kind`
--&gt; src/main.rs:3:14
|
3 | #[tea(kind = async { replicator.await })]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^</code></pre></div></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-Freeze-for-ParseNestedMeta%3C'a%3E" class="impl"><a href="#impl-Freeze-for-ParseNestedMeta%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.ParseNestedMeta.html" title="struct syn::meta::ParseNestedMeta">ParseNestedMeta</a>&lt;'a&gt;</h3></section><section id="impl-RefUnwindSafe-for-ParseNestedMeta%3C'a%3E" class="impl"><a href="#impl-RefUnwindSafe-for-ParseNestedMeta%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ParseNestedMeta.html" title="struct syn::meta::ParseNestedMeta">ParseNestedMeta</a>&lt;'a&gt;</h3></section><section id="impl-Send-for-ParseNestedMeta%3C'a%3E" class="impl"><a href="#impl-Send-for-ParseNestedMeta%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ParseNestedMeta.html" title="struct syn::meta::ParseNestedMeta">ParseNestedMeta</a>&lt;'a&gt;</h3></section><section id="impl-Sync-for-ParseNestedMeta%3C'a%3E" class="impl"><a href="#impl-Sync-for-ParseNestedMeta%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; !<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ParseNestedMeta.html" title="struct syn::meta::ParseNestedMeta">ParseNestedMeta</a>&lt;'a&gt;</h3></section><section id="impl-Unpin-for-ParseNestedMeta%3C'a%3E" class="impl"><a href="#impl-Unpin-for-ParseNestedMeta%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ParseNestedMeta.html" title="struct syn::meta::ParseNestedMeta">ParseNestedMeta</a>&lt;'a&gt;</h3></section><section id="impl-UnwindSafe-for-ParseNestedMeta%3C'a%3E" class="impl"><a href="#impl-UnwindSafe-for-ParseNestedMeta%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ParseNestedMeta.html" title="struct syn::meta::ParseNestedMeta">ParseNestedMeta</a>&lt;'a&gt;</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.83.0/src/core/any.rs.html#138">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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.83.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.83.0/src/core/any.rs.html#139">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.83.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.83.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.83.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.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.83.0/src/core/borrow.rs.html#211">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.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.83.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.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.83.0/src/core/borrow.rs.html#218">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.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.83.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; 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.83.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; 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.83.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</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.83.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; 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.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; 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.83.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.83.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.83.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</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.83.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.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.83.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>