mentat/memoffset/macro.span_of.html

194 lines
14 KiB
HTML
Raw Permalink Normal View History

2018-08-22 17:04:13 +00:00
<!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 `span_of` macro in crate `memoffset`.">
<meta name="keywords" content="rust, rustlang, rust-lang, span_of">
<title>memoffset::span_of - 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="../main.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc macro">
<!--[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">&#9776;</div>
<p class='location'><a href='index.html'>memoffset</a></p><script>window.sidebarCurrent = {name: 'span_of', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</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">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Macro <a href='index.html'>memoffset</a>::<wbr><a class="macro" href=''>span_of</a></span><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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/memoffset/span_of.rs.html#83-131' title='goto source code'>[src]</a></span></h1>
<pre class="rust macro">
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">span_of</span> {
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, [] ..=) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, [] ..) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, [] ..= $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">field</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, [] .. $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">field</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, $(# <span class="macro-nonterminal">$</span><span class="macro-nonterminal">begin</span>:<span class="ident">tt</span>)<span class="op">+</span> [] ..= $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">end</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, $(# <span class="macro-nonterminal">$</span><span class="macro-nonterminal">begin</span>:<span class="ident">tt</span>)<span class="op">+</span> [] .. $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">end</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, $(# <span class="macro-nonterminal">$</span><span class="macro-nonterminal">begin</span>:<span class="ident">tt</span>)<span class="op">+</span> [] ..) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, $(# <span class="macro-nonterminal">$</span><span class="macro-nonterminal">begin</span>:<span class="ident">tt</span>)<span class="op">+</span> [] ..=) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, $(# <span class="macro-nonterminal">$</span><span class="macro-nonterminal">begin</span>:<span class="ident">tt</span>)<span class="op">+</span> []) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, $(# <span class="macro-nonterminal">$</span><span class="macro-nonterminal">begin</span>:<span class="ident">tt</span>)<span class="op">+</span> [] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">rest</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> { ... };
(@<span class="ident">helper</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">root</span>:<span class="ident">ident</span>, [] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">tt</span>:<span class="ident">tt</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">rest</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> { ... };
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">sty</span>:<span class="ident">ty</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">exp</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=&gt;</span> { ... };
}</pre>
<div class='docblock'><p>Produces a range instance representing the sub-slice containing the specified member.</p>
<p>This macro provides 2 forms of differing functionalities.</p>
<p>The first form is identical to the appearance of the <code>offset_of!</code> macro,
and just like <code>offset_of!</code>, it has no limit on the depth of fields / subscripts used.</p>
<div class='information'><div class='tooltip ignore'><span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
<span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Struct</span>, <span class="ident">member</span>[<span class="ident">index</span>].<span class="ident">field</span>)</pre>
<p>The second form of <code>span_of!</code> returns a sub-slice which starts at one field, and ends at another.
The general pattern of this form is:</p>
<div class='information'><div class='tooltip ignore'><span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
<span class="comment">// Exclusive</span>
<span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Struct</span>, <span class="ident">member_a</span> .. <span class="ident">member_b</span>)
<span class="comment">// Inclusive</span>
<span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Struct</span>, <span class="ident">member_a</span> ..= <span class="ident">member_b</span>)
<span class="comment">// Open-ended ranges</span>
<span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Struct</span>, .. <span class="ident">end</span>)
<span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Struct</span>, <span class="ident">start</span> ..)</pre>
<p><em>Note</em>:
This macro uses recursion in order to resolve the range expressions, so there is a limit to the complexity of the expression.
In order to raise the limit, the compiler's recursion limit should be lifted.</p>
<p><em>Note</em>:
This macro may not make much sense when used on structs that are not <code>#[repr(C, packed)]</code></p>
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
<pre class="rust rust-example-rendered">
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">memoffset</span>;
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>, <span class="ident">packed</span>)]</span>
<span class="kw">struct</span> <span class="ident">Florp</span> {
<span class="ident">a</span>: <span class="ident">u32</span>
}
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>, <span class="ident">packed</span>)]</span>
<span class="kw">struct</span> <span class="ident">Blarg</span> {
<span class="ident">x</span>: <span class="ident">u64</span>,
<span class="ident">y</span>: [<span class="ident">u8</span>; <span class="number">56</span>],
<span class="ident">z</span>: <span class="ident">Florp</span>,
<span class="ident">egg</span>: [[<span class="ident">u8</span>; <span class="number">4</span>]; <span class="number">4</span>]
}
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0</span>..<span class="number">8</span>, <span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Blarg</span>, <span class="ident">x</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">64</span>..<span class="number">68</span>, <span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Blarg</span>, <span class="ident">z</span>.<span class="ident">a</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">79</span>..<span class="number">80</span>, <span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Blarg</span>, <span class="ident">egg</span>[<span class="number">2</span>][<span class="number">3</span>]));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">8</span>..<span class="number">64</span>, <span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Blarg</span>, <span class="ident">y</span>[<span class="number">0</span>] .. <span class="ident">z</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0</span>..<span class="number">42</span>, <span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Blarg</span>, <span class="ident">x</span> .. <span class="ident">y</span>[<span class="number">34</span>]));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0</span>..<span class="number">64</span>, <span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Blarg</span>, <span class="ident">x</span> ..= <span class="ident">y</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">58</span>..<span class="number">68</span>, <span class="macro">span_of</span><span class="macro">!</span>(<span class="ident">Blarg</span>, <span class="ident">y</span>[<span class="number">50</span>] ..= <span class="ident">z</span>));
}</pre>
</div></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>&#9166;</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "memoffset";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>