172 lines
8.3 KiB
HTML
172 lines
8.3 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 `offset_of` macro in crate `memoffset`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, offset_of">
|
|||
|
|
|
|||
|
|
<title>memoffset::offset_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">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'><a href='index.html'>memoffset</a></p><script>window.sidebarCurrent = {name: 'offset_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=''>offset_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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/memoffset/offset_of.rs.html#68-83' 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">offset_of</span> {
|
|||
|
|
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">father</span>:<span class="ident">ty</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">field</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=></span> { ... };
|
|||
|
|
}</pre>
|
|||
|
|
<div class='docblock'><p>Calculates the offset of the specified field from the start of the struct.
|
|||
|
|
This macro supports arbitrary amount of subscripts and recursive member-accesses.</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---simple" class="section-header"><a href="#examples---simple">Examples - Simple</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">Foo</span> {
|
|||
|
|
<span class="ident">a</span>: <span class="ident">u32</span>,
|
|||
|
|
<span class="ident">b</span>: <span class="ident">u64</span>,
|
|||
|
|
<span class="ident">c</span>: [<span class="ident">u8</span>; <span class="number">5</span>]
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">offset_of</span><span class="macro">!</span>(<span class="ident">Foo</span>, <span class="ident">a</span>), <span class="number">0</span>);
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">offset_of</span><span class="macro">!</span>(<span class="ident">Foo</span>, <span class="ident">b</span>), <span class="number">4</span>);
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">offset_of</span><span class="macro">!</span>(<span class="ident">Foo</span>, <span class="ident">c</span>[<span class="number">2</span>]), <span class="number">14</span>);
|
|||
|
|
}</pre>
|
|||
|
|
<h2 id="examples---advanced" class="section-header"><a href="#examples---advanced">Examples - Advanced</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">UnnecessarilyComplicatedStruct</span> {
|
|||
|
|
<span class="ident">member</span>: [<span class="ident">UnnecessarilyComplexStruct</span>; <span class="number">12</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">UnnecessarilyComplexStruct</span> {
|
|||
|
|
<span class="ident">a</span>: <span class="ident">u32</span>,
|
|||
|
|
<span class="ident">b</span>: <span class="ident">u64</span>,
|
|||
|
|
<span class="ident">c</span>: [<span class="ident">u8</span>; <span class="number">5</span>]
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">offset_of</span><span class="macro">!</span>(<span class="ident">UnnecessarilyComplicatedStruct</span>, <span class="ident">member</span>[<span class="number">3</span>].<span class="ident">c</span>[<span class="number">3</span>]), <span class="number">66</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>⏎</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>
|