edlang/regex_syntax/struct.ParserBuilder.html

115 lines
41 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="A builder for a regular expression parser."><title>ParserBuilder in regex_syntax - 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-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="regex_syntax" 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" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.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="../regex_syntax/index.html">regex_syntax</a><span class="version">0.8.4</span></h2></div><h2 class="location"><a href="#">ParserBuilder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.build">build</a></li><li><a href="#method.case_insensitive">case_insensitive</a></li><li><a href="#method.crlf">crlf</a></li><li><a href="#method.dot_matches_new_line">dot_matches_new_line</a></li><li><a href="#method.ignore_whitespace">ignore_whitespace</a></li><li><a href="#method.line_terminator">line_terminator</a></li><li><a href="#method.multi_line">multi_line</a></li><li><a href="#method.nest_limit">nest_limit</a></li><li><a href="#method.new">new</a></li><li><a href="#method.octal">octal</a></li><li><a href="#method.swap_greed">swap_greed</a></li><li><a href="#method.unicode">unicode</a></li><li><a href="#method.utf8">utf8</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-ParserBuilder">Clone</a></li><li><a href="#impl-Debug-for-ParserBuilder">Debug</a></li><li><a href="#impl-Default-for-ParserBuilder">Default</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-ParserBuilder">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-ParserBuilder">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ParserBuilder">Send</a></li><li><a href="#impl-Sync-for-ParserBuilder">Sync</a></li><li><a href="#impl-Unpin-for-ParserBuilder">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ParserBuilder">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&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a hre
<p>This builder permits modifying configuration options for the parser.</p>
<p>This type combines the builder options for both the <a href="ast/parse/struct.ParserBuilder.html" title="struct regex_syntax::ast::parse::ParserBuilder">AST
<code>ParserBuilder</code></a> and the <a href="hir/translate/struct.TranslatorBuilder.html" title="struct regex_syntax::hir::translate::TranslatorBuilder">HIR
<code>TranslatorBuilder</code></a>.</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-ParserBuilder" class="impl"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#30-214">source</a><a href="#impl-ParserBuilder" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</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/regex_syntax/parser.rs.html#32-34">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -&gt; <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Create a new parser builder with a default configuration.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.build" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#37-39">source</a><h4 class="code-header">pub fn <a href="#method.build" class="fn">build</a>(&amp;self) -&gt; <a class="struct" href="struct.Parser.html" title="struct regex_syntax::Parser">Parser</a></h4></section></summary><div class="docblock"><p>Build a parser from this configuration with the given pattern.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.nest_limit" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#66-69">source</a><h4 class="code-header">pub fn <a href="#method.nest_limit" class="fn">nest_limit</a>(&amp;mut self, limit: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u32.html">u32</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Set the nesting limit for this parser.</p>
<p>The nesting limit controls how deep the abstract syntax tree is allowed
to be. If the AST exceeds the given limit (e.g., with too many nested
groups), then an error is returned by the parser.</p>
<p>The purpose of this limit is to act as a heuristic to prevent stack
overflow for consumers that do structural induction on an <code>Ast</code> using
explicit recursion. While this crate never does this (instead using
constant stack space and moving the call stack to the heap), other
crates may.</p>
<p>This limit is not checked until the entire Ast is parsed. Therefore,
if callers want to put a limit on the amount of heap space used, then
they should impose a limit on the length, in bytes, of the concrete
pattern string. In particular, this is viable since this parser
implementation will limit itself to heap space proportional to the
length of the pattern string.</p>
<p>Note that a nest limit of <code>0</code> will return a nest limit error for most
patterns but not all. For example, a nest limit of <code>0</code> permits <code>a</code> but
not <code>ab</code>, since <code>ab</code> requires a concatenation, which results in a nest
depth of <code>1</code>. In general, a nest limit is not something that manifests
in an obvious way in the concrete syntax, therefore, it should not be
used in a granular way.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.octal" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#86-89">source</a><h4 class="code-header">pub fn <a href="#method.octal" class="fn">octal</a>(&amp;mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Whether to support octal syntax or not.</p>
<p>Octal syntax is a little-known way of uttering Unicode codepoints in
a regular expression. For example, <code>a</code>, <code>\x61</code>, <code>\u0061</code> and
<code>\141</code> are all equivalent regular expressions, where the last example
shows octal syntax.</p>
<p>While supporting octal syntax isnt in and of itself a problem, it does
make good error messages harder. That is, in PCRE based regex engines,
syntax like <code>\0</code> invokes a backreference, which is explicitly
unsupported in Rusts regex engine. However, many users expect it to
be supported. Therefore, when octal support is disabled, the error
message will explicitly mention that backreferences arent supported.</p>
<p>Octal syntax is disabled by default.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.utf8" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#106-109">source</a><h4 class="code-header">pub fn <a href="#method.utf8" class="fn">utf8</a>(&amp;mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>When disabled, translation will permit the construction of a regular
expression that may match invalid UTF-8.</p>
<p>When enabled (the default), the translator is guaranteed to produce an
expression that, for non-empty matches, will only ever produce spans
that are entirely valid UTF-8 (otherwise, the translator will return an
error).</p>
<p>Perhaps surprisingly, when UTF-8 is enabled, an empty regex or even
a negated ASCII word boundary (uttered as <code>(?-u:\B)</code> in the concrete
syntax) will be allowed even though they can produce matches that split
a UTF-8 encoded codepoint. This only applies to zero-width or “empty”
matches, and it is expected that the regex engine itself must handle
these cases if necessary (perhaps by suppressing any zero-width matches
that split a codepoint).</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.ignore_whitespace" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#119-122">source</a><h4 class="code-header">pub fn <a href="#method.ignore_whitespace" class="fn">ignore_whitespace</a>(&amp;mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Enable verbose mode in the regular expression.</p>
<p>When enabled, verbose mode permits insignificant whitespace in many
places in the regular expression, as well as comments. Comments are
started using <code>#</code> and continue until the end of the line.</p>
<p>By default, this is disabled. It may be selectively enabled in the
regular expression by using the <code>x</code> flag regardless of this setting.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.case_insensitive" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#128-131">source</a><h4 class="code-header">pub fn <a href="#method.case_insensitive" class="fn">case_insensitive</a>(&amp;mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Enable or disable the case insensitive flag by default.</p>
<p>By default this is disabled. It may alternatively be selectively
enabled in the regular expression itself via the <code>i</code> flag.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.multi_line" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#137-140">source</a><h4 class="code-header">pub fn <a href="#method.multi_line" class="fn">multi_line</a>(&amp;mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Enable or disable the multi-line matching flag by default.</p>
<p>By default this is disabled. It may alternatively be selectively
enabled in the regular expression itself via the <code>m</code> flag.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.dot_matches_new_line" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#146-149">source</a><h4 class="code-header">pub fn <a href="#method.dot_matches_new_line" class="fn">dot_matches_new_line</a>(&amp;mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Enable or disable the “dot matches any character” flag by default.</p>
<p>By default this is disabled. It may alternatively be selectively
enabled in the regular expression itself via the <code>s</code> flag.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.crlf" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#163-166">source</a><h4 class="code-header">pub fn <a href="#method.crlf" class="fn">crlf</a>(&amp;mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Enable or disable the CRLF mode flag by default.</p>
<p>By default this is disabled. It may alternatively be selectively
enabled in the regular expression itself via the <code>R</code> flag.</p>
<p>When CRLF mode is enabled, the following happens:</p>
<ul>
<li>Unless <code>dot_matches_new_line</code> is enabled, <code>.</code> will match any character
except for <code>\r</code> and <code>\n</code>.</li>
<li>When <code>multi_line</code> mode is enabled, <code>^</code> and <code>$</code> will treat <code>\r\n</code>,
<code>\r</code> and <code>\n</code> as line terminators. And in particular, neither will
match between a <code>\r</code> and a <code>\n</code>.</li>
</ul>
</div></details><details class="toggle method-toggle" open><summary><section id="method.line_terminator" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#188-191">source</a><h4 class="code-header">pub fn <a href="#method.line_terminator" class="fn">line_terminator</a>(&amp;mut self, byte: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Sets the line terminator for use with <code>(?u-s:.)</code> and <code>(?-us:.)</code>.</p>
<p>Namely, instead of <code>.</code> (by default) matching everything except for <code>\n</code>,
this will cause <code>.</code> to match everything except for the byte given.</p>
<p>If <code>.</code> is used in a context where Unicode mode is enabled and this byte
isnt ASCII, then an error will be returned. When Unicode mode is
disabled, then any byte is permitted, but will return an error if UTF-8
mode is enabled and it is a non-ASCII byte.</p>
<p>In short, any ASCII value for a line terminator is always okay. But a
non-ASCII byte might result in an error depending on whether Unicode
mode or UTF-8 mode are enabled.</p>
<p>Note that if <code>R</code> mode is enabled then it always takes precedence and
the line terminator will be treated as <code>\r</code> and <code>\n</code> simultaneously.</p>
<p>Note also that this <em>doesnt</em> impact the look-around assertions
<code>(?m:^)</code> and <code>(?m:$)</code>. Thats usually controlled by additional
configuration in the regex engine itself.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap_greed" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#197-200">source</a><h4 class="code-header">pub fn <a href="#method.swap_greed" class="fn">swap_greed</a>(&amp;mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Enable or disable the “swap greed” flag by default.</p>
<p>By default this is disabled. It may alternatively be selectively
enabled in the regular expression itself via the <code>U</code> flag.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.unicode" class="method"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#210-213">source</a><h4 class="code-header">pub fn <a href="#method.unicode" class="fn">unicode</a>(&amp;mut self, yes: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>) -&gt; &amp;mut <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class="docblock"><p>Enable or disable the Unicode flag (<code>u</code>) by default.</p>
<p>By default this is <strong>enabled</strong>. It may alternatively be selectively
disabled in the regular expression itself via the <code>u</code> flag.</p>
<p>Note that unless <code>utf8</code> is disabled (its enabled by default), a
regular expression will fail to parse if Unicode mode is disabled and a
sub-expression could possibly match invalid UTF-8.</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-Clone-for-ParserBuilder" class="impl"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#24">source</a><a href="#impl-Clone-for-ParserBuilder" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#24">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.80.0/src/core/clone.rs.html#169">source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;Self</a>)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-ParserBuilder" class="impl"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#24">source</a><a href="#impl-Debug-for-ParserBuilder" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ParserBuilder.html" title="struct regex_syntax::ParserBuilder">ParserBuilder</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#24">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.80.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-ParserBuilder" class="impl"><a class="src rightside" href="../src/regex_syntax/parser.rs.html#24">source</a><a href="#impl-Default-for-ParserBuilder" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://d
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.80.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.80.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.80.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.80.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.80.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.80.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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.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.80.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.80.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.80.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.80.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.80.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.80.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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#83-85">source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
T: <a class="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><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></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.80.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.80.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.80.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" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="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><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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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-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.80.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.80.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.80.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.80.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.80.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.80.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.80.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.80.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>