mirror of
https://github.com/fluencelabs/wasmer
synced 2025-06-13 00:51:20 +00:00
29 lines
8.1 KiB
HTML
29 lines
8.1 KiB
HTML
<!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="API documentation for the Rust `scoped` mod in crate `take_mut`."><meta name="keywords" content="rust, rustlang, rust-lang, scoped"><title>take_mut::scoped - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../take_mut/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module scoped</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>take_mut</a></p><script>window.sidebarCurrent = {name: 'scoped', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/take_mut/scoped.rs.html#1-175' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>take_mut</a>::<wbr><a class="mod" href=''>scoped</a></span></h1><div class='docblock'><p>This module provides a scoped API, allowing for taking an arbitrary number of <code>&mut T</code> into <code>T</code> within one closure.
|
||
The references are all required to outlive the closure.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">take_mut</span>::<span class="ident">scoped</span>;
|
||
<span class="kw">struct</span> <span class="ident">Foo</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">Foo</span>; <span class="comment">// Must outlive scope</span>
|
||
<span class="ident">scoped</span>::<span class="ident">scope</span>(<span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
|
||
<span class="kw">let</span> (<span class="ident">t</span>, <span class="ident">hole</span>) <span class="op">=</span> <span class="ident">scope</span>.<span class="ident">take</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">foo</span>);
|
||
<span class="ident">drop</span>(<span class="ident">t</span>);
|
||
<span class="ident">hole</span>.<span class="ident">fill</span>(<span class="ident">Foo</span>); <span class="comment">// If not called before the closure ends, causes an abort.</span>
|
||
});</pre></div>
|
||
<h1 id="invalid-example-does-not-compile" class="section-header"><a href="#invalid-example-does-not-compile">Invalid Example (does not compile)</a></h1>
|
||
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
|
||
<span class="kw">use</span> <span class="ident">take_mut</span>::<span class="ident">scoped</span>;
|
||
<span class="kw">struct</span> <span class="ident">Foo</span>;
|
||
<span class="ident">scoped</span>::<span class="ident">scope</span>(<span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">foo</span> <span class="op">=</span> <span class="ident">Foo</span>; <span class="comment">// Invalid because foo must come from outside the scope.</span>
|
||
<span class="kw">let</span> (<span class="ident">t</span>, <span class="ident">hole</span>) <span class="op">=</span> <span class="ident">scope</span>.<span class="ident">take</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">foo</span>);
|
||
<span class="ident">drop</span>(<span class="ident">t</span>);
|
||
<span class="ident">hole</span>.<span class="ident">fill</span>(<span class="ident">Foo</span>);
|
||
});</pre></div>
|
||
<p><code>Scope</code> also offers <code>take_or_recover</code>, which takes a function to call in the event the hole isn't filled.</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.Hole.html" title='take_mut::scoped::Hole struct'>Hole</a></td><td class='docblock-short'><p>A <code>Hole<'c, 'm, T, F></code> represents an unfilled <code>&'m mut T</code> which must be filled before the end of the <code>Scope</code> with lifetime <code>'c</code> and recovery closure <code>F</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Scope.html" title='take_mut::scoped::Scope struct'>Scope</a></td><td class='docblock-short'><p>Represents a scope within which, it is possible to take a <code>T</code> from a <code>&mut T</code> as long as the <code>&mut T</code> outlives the scope.</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.scope.html" title='take_mut::scoped::scope fn'>scope</a></td><td class='docblock-short'><p>Main function to create a <code>Scope</code>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "take_mut";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |