blob: 930fe1d795d8ab354ffa436bf4aaf1b18cde5866 [file] [log] [blame]
<!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="The error type for `try_reserve` methods."><meta name="keywords" content="rust, rustlang, rust-lang, TryReserveError"><title>TryReserveError in hashbrown - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc enum"><!--[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">&#9776;</button><a class="sidebar-logo" href="../hashbrown/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../hashbrown/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">TryReserveError</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block"><li><a href="#variant.AllocError">AllocError</a></li><li><a href="#variant.CapacityOverflow">CapacityOverflow</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-TryReserveError">Clone</a></li><li><a href="#impl-Debug-for-TryReserveError">Debug</a></li><li><a href="#impl-Eq-for-TryReserveError">Eq</a></li><li><a href="#impl-PartialEq%3CTryReserveError%3E-for-TryReserveError">PartialEq&lt;TryReserveError&gt;</a></li><li><a href="#impl-StructuralEq-for-TryReserveError">StructuralEq</a></li><li><a href="#impl-StructuralPartialEq-for-TryReserveError">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-TryReserveError">RefUnwindSafe</a></li><li><a href="#impl-Send-for-TryReserveError">Send</a></li><li><a href="#impl-Sync-for-TryReserveError">Sync</a></li><li><a href="#impl-Unpin-for-TryReserveError">Unpin</a></li><li><a href="#impl-UnwindSafe-for-TryReserveError">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-TryReserveError">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-TryReserveError">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-TryReserveError">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-TryReserveError">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-TryReserveError">Into&lt;U&gt;</a></li><li><a href="#impl-ToOwned-for-TryReserveError">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-TryReserveError">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-TryReserveError">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In hashbrown</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Enum <a href="index.html">hashbrown</a>::<wbr><a class="enum" href="#">TryReserveError</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/hashbrown/lib.rs.html#122-132">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust enum"><code>pub enum TryReserveError {
CapacityOverflow,
AllocError {
layout: Layout,
},
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The error type for <code>try_reserve</code> methods.</p>
</div></details><h2 id="variants" class="variants small-section-header">Variants<a href="#variants" class="anchor"></a></h2><h3 id="variant.CapacityOverflow" class="variant small-section-header"><a href="#variant.CapacityOverflow" class="anchor field"></a><code>CapacityOverflow</code></h3><div class="docblock"><p>Error due to the computed capacity exceeding the collection’s maximum
(usually <code>isize::MAX</code> bytes).</p>
</div><h3 id="variant.AllocError" class="variant small-section-header"><a href="#variant.AllocError" class="anchor field"></a><code>AllocError</code></h3><div class="sub-variant" id="variant.AllocError.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.AllocError.field.layout" class="variant small-section-header"><a href="#variant.AllocError.field.layout" class="anchor field"></a><code>layout:&nbsp;Layout</code></span><div class="docblock"><p>The layout of the allocation request that failed.</p>
</div></div></div><div class="docblock"><p>The memory allocator returned an error</p>
</div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-TryReserveError" class="impl has-srclink"><a class="srclink rightside" href="../src/hashbrown/lib.rs.html#121">source</a><a href="#impl-Clone-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl Clone for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/hashbrown/lib.rs.html#121">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-TryReserveError" class="impl has-srclink"><a class="srclink rightside" href="../src/hashbrown/lib.rs.html#121">source</a><a href="#impl-Debug-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl Debug for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/hashbrown/lib.rs.html#121">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CTryReserveError%3E-for-TryReserveError" class="impl has-srclink"><a class="srclink rightside" href="../src/hashbrown/lib.rs.html#121">source</a><a href="#impl-PartialEq%3CTryReserveError%3E-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl PartialEq&lt;<a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a>&gt; for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/hashbrown/lib.rs.html#121">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a class="fnname">eq</a>(&amp;self, other: &amp;<a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a>) -&gt; bool</h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.ne" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ne</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
sufficient, and should not be overridden without very good reason. <a>Read more</a></div></details></div></details><section id="impl-Eq-for-TryReserveError" class="impl has-srclink"><a class="srclink rightside" href="../src/hashbrown/lib.rs.html#121">source</a><a href="#impl-Eq-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl Eq for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section><section id="impl-StructuralEq-for-TryReserveError" class="impl has-srclink"><a class="srclink rightside" href="../src/hashbrown/lib.rs.html#121">source</a><a href="#impl-StructuralEq-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl StructuralEq for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section><section id="impl-StructuralPartialEq-for-TryReserveError" class="impl has-srclink"><a class="srclink rightside" href="../src/hashbrown/lib.rs.html#121">source</a><a href="#impl-StructuralPartialEq-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl StructuralPartialEq for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-TryReserveError" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section><section id="impl-Send-for-TryReserveError" class="impl has-srclink"><a href="#impl-Send-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl Send for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section><section id="impl-Sync-for-TryReserveError" class="impl has-srclink"><a href="#impl-Sync-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl Sync for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section><section id="impl-Unpin-for-TryReserveError" class="impl has-srclink"><a href="#impl-Unpin-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section><section id="impl-UnwindSafe-for-TryReserveError" class="impl has-srclink"><a href="#impl-UnwindSafe-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-TryReserveError" class="impl has-srclink"><a href="#impl-Any-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-TryReserveError" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-TryReserveError" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-TryReserveError" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-TryReserveError" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-TryReserveError" class="impl has-srclink"><a href="#impl-ToOwned-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; ToOwned for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&amp;self, target: &amp;mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-TryReserveError" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-TryReserveError" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-TryReserveError" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="hashbrown" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>