Skip to content

Commit

Permalink
generated at
Browse files Browse the repository at this point in the history
  • Loading branch information
steveklabnik committed Mar 29, 2017
1 parent 9a70a2d commit 5d17061
Show file tree
Hide file tree
Showing 1,893 changed files with 33,817 additions and 99,009 deletions.
5 changes: 1 addition & 4 deletions alloc/arc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,7 @@ <h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>alloc</a>::
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/alloc/arc.rs.html#11-1468' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Thread-safe reference-counting pointers.</p>

<p>See the <a href="struct.Arc.html"><code>Arc&lt;T&gt;</code></a> documentation for more details.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<div class='docblock'><p>Thread-safe reference-counting pointers.</p><p>See the <a href="struct.Arc.html"><code>Arc&lt;T&gt;</code></a> documentation for more details.</p></div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Arc.html"
Expand Down
231 changes: 35 additions & 196 deletions alloc/arc/struct.Arc.html

Large diffs are not rendered by default.

53 changes: 8 additions & 45 deletions alloc/arc/struct.Weak.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,37 +49,17 @@ <h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>alloc</a>::
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/alloc/arc.rs.html#181-183' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Weak&lt;T:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A weak version of <a href="struct.Arc.html"><code>Arc</code></a>.</p>

<p><code>Weak</code> pointers do not count towards determining if the inner value
should be dropped.</p>

<p>The typical way to obtain a <code>Weak</code> pointer is to call
<a href="struct.Arc.html#method.downgrade"><code>Arc::downgrade</code></a>.</p>

<p>See the <a href="struct.Arc.html"><code>Arc</code></a> documentation for more details.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/arc.rs.html#768-798' title='goto source code'>[src]</a></span></h3>
<pre class='rust struct'>pub struct Weak&lt;T:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A weak version of <a href="struct.Arc.html"><code>Arc</code></a>.</p><p><code>Weak</code> pointers do not count towards determining if the inner value should be dropped.</p><p>The typical way to obtain a <code>Weak</code> pointer is to call <a href="struct.Arc.html#method.downgrade"><code>Arc::downgrade</code></a>.</p><p>See the <a href="struct.Arc.html"><code>Arc</code></a> documentation for more details.</p></div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/arc.rs.html#768-798' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code><div class='since' title='Stable since Rust version 1.10.0'>1.10.0</div></span></h4>
<div class='docblock'><p>Constructs a new <code>Weak&lt;T&gt;</code>, without an accompanying instance of <code>T</code>.</p>

<p>This allocates memory for <code>T</code>, but does not initialize it. Calling
<a href="struct.Weak.html#method.upgrade"><code>upgrade</code></a> on the return value always gives
<a href="../../std/option/enum.Option.html"><code>None</code></a>.</p>

<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<div class='docblock'><p>Constructs a new <code>Weak&lt;T&gt;</code>, without an accompanying instance of <code>T</code>.</p><p>This allocates memory for <code>T</code>, but does not initialize it. Calling <a href="struct.Weak.html#method.upgrade"><code>upgrade</code></a> on the return value always gives <a href="../../std/option/enum.Option.html"><code>None</code></a>.</p><h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Weak</span>;

<span class="kw">let</span> <span class="ident">empty</span>: <span class="ident">Weak</span><span class="op">&lt;</span><span class="ident">i64</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">Weak</span>::<span class="ident">new</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">empty</span>.<span class="ident">upgrade</span>().<span class="ident">is_none</span>());</pre>
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/arc.rs.html#800-864' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.upgrade' class="method"><span id='upgrade.v' class='invisible'><code>fn <a href='#method.upgrade' class='fnname'>upgrade</a>(&amp;self) -&gt; <a class="enum" href="../../core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../alloc/arc/struct.Arc.html" title="struct alloc::arc::Arc">Arc</a>&lt;T&gt;&gt;</code></span></h4>
<div class='docblock'><p>Upgrades the <code>Weak</code> pointer to an <a href="struct.Arc.html"><code>Arc</code></a>, if possible.</p>

<p>Returns <a href="../../std/option/enum.Option.html"><code>None</code></a> if the strong count has reached zero and the
inner value was destroyed.</p>

<h1 id='examples-1' class='section-header'><a href='#examples-1'>Examples</a></h1>
<div class='docblock'><p>Upgrades the <code>Weak</code> pointer to an <a href="struct.Arc.html"><code>Arc</code></a>, if possible.</p><p>Returns <a href="../../std/option/enum.Option.html"><code>None</code></a> if the strong count has reached zero and the inner value was destroyed.</p><h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;

Expand All @@ -100,44 +80,27 @@ <h1 id='examples-1' class='section-header'><a href='#examples-1'>Examples</a></h
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../core/marker/trait.Unsize.html" title="trait core::marker::Unsize">Unsize</a>&lt;U&gt;, U:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="../../core/ops/trait.CoerceUnsized.html" title="trait core::ops::CoerceUnsized">CoerceUnsized</a>&lt;<a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;U&gt;&gt; for <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/arc.rs.html#191' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>&gt; <a class="trait" href="../../core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/arc.rs.html#194-198' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='../../core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="../../core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="../../core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="../../core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/arc.rs.html#867-899' title='goto source code'>[src]</a></span></h3>
<div class='docblock'><p>Formats the value using the given formatter.</p></div></div><h3 class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="../../core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/arc.rs.html#867-899' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='../../core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span></h4>
<div class='docblock'><p>Makes a clone of the <code>Weak</code> pointer.</p>

<p>This creates another pointer to the same inner value, increasing the
weak reference count.</p>

<h1 id='examples-2' class='section-header'><a href='#examples-2'>Examples</a></h1>
<div class='docblock'><p>Makes a clone of the <code>Weak</code> pointer.</p><p>This creates another pointer to the same inner value, increasing the weak reference count.</p><h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;

<span class="kw">let</span> <span class="ident">weak_five</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">downgrade</span>(<span class="kw-2">&amp;</span><span class="ident">Arc</span>::<span class="ident">new</span>(<span class="number">5</span>));

<span class="ident">weak_five</span>.<span class="ident">clone</span>();</pre>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='../../core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="../../core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="../../core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.10.0'>1.10.0</div><a class='srclink' href='../../src/alloc/arc.rs.html#902-923' title='goto source code'>[src]</a></span></h3>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="../../core/clone/trait.Clone.html#method.clone_from">Read more</a></p></div></div><h3 class='impl'><span class='in-band'><code>impl&lt;T&gt; <a class="trait" href="../../core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.10.0'>1.10.0</div><a class='srclink' href='../../src/alloc/arc.rs.html#902-923' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='../../core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span></h4>
<div class='docblock'><p>Constructs a new <code>Weak&lt;T&gt;</code>, without an accompanying instance of <code>T</code>.</p>

<p>This allocates memory for <code>T</code>, but does not initialize it. Calling
<a href="struct.Weak.html#method.upgrade"><code>upgrade</code></a> on the return value always gives
<a href="../../std/option/enum.Option.html"><code>None</code></a>.</p>

<h1 id='examples-3' class='section-header'><a href='#examples-3'>Examples</a></h1>
<div class='docblock'><p>Constructs a new <code>Weak&lt;T&gt;</code>, without an accompanying instance of <code>T</code>.</p><p>This allocates memory for <code>T</code>, but does not initialize it. Calling <a href="struct.Weak.html#method.upgrade"><code>upgrade</code></a> on the return value always gives <a href="../../std/option/enum.Option.html"><code>None</code></a>.</p><h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Weak</span>;

<span class="kw">let</span> <span class="ident">empty</span>: <span class="ident">Weak</span><span class="op">&lt;</span><span class="ident">i64</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">Default</span>::<span class="ident">default</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">empty</span>.<span class="ident">upgrade</span>().<span class="ident">is_none</span>());</pre>
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;T:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt; <a class="trait" href="../../core/ops/trait.Drop.html" title="trait core::ops::Drop">Drop</a> for <a class="struct" href="../../alloc/arc/struct.Weak.html" title="struct alloc::arc::Weak">Weak</a>&lt;T&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alloc/arc.rs.html#926-969' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><code>fn <a href='../../core/ops/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&amp;mut self)</code></span></h4>
<div class='docblock'><p>Drops the <code>Weak</code> pointer.</p>

<p>This will decrement the weak reference count.</p>

<h1 id='examples-4' class='section-header'><a href='#examples-4'>Examples</a></h1>
<div class='docblock'><p>Drops the <code>Weak</code> pointer.</p><p>This will decrement the weak reference count.</p><h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;

Expand Down
7 changes: 1 addition & 6 deletions alloc/boxed/constant.HEAP.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,7 @@ <h1 class='fqn'><span class='in-band'>Constant <a href='../index.html'>alloc</a>
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/alloc/boxed.rs.html#91' title='goto source code'>[src]</a></span></h1>
<pre class='rust const'>pub const HEAP: <a class="struct" href="../../alloc/boxed/struct.ExchangeHeapSingleton.html" title="struct alloc::boxed::ExchangeHeapSingleton">ExchangeHeapSingleton</a><code> = </code><code>ExchangeHeapSingleton{_force_singleton: (),}</code></pre><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>box_heap </code><a href="https://github.com/rust-lang/rust/issues/27779">#27779</a>)</summary><p>may be renamed; uncertain about custom allocator design</p>
</details></div></div><div class='docblock'><p>A value that represents the heap. This is the default place that the <code>box</code>
keyword allocates into when no place is supplied.</p>

<p>The following two examples are equivalent:</p>

<pre class='rust const'>pub const HEAP: <a class="struct" href="../../alloc/boxed/struct.ExchangeHeapSingleton.html" title="struct alloc::boxed::ExchangeHeapSingleton">ExchangeHeapSingleton</a><code> = </code><code>ExchangeHeapSingleton{_force_singleton: (),}</code></pre><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>box_heap </code><a href="https://github.com/rust-lang/rust/issues/27779">#27779</a>)</summary><p>may be renamed; uncertain about custom allocator design</p></details></div></div><div class='docblock'><p>A value that represents the heap. This is the default place that the <code>box</code> keyword allocates into when no place is supplied.</p><p>The following two examples are equivalent:</p>
<pre class="rust rust-example-rendered">
<span class="attribute">#<span class="op">!</span>[<span class="ident">feature</span>(<span class="ident">box_heap</span>)]</span>

Expand Down
Loading

0 comments on commit 5d17061

Please sign in to comment.