Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -0,0 +1,64 @@
|
||||
<!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="Produces a range instance representing the sub-slice containing the specified member."><title>span_of in memoffset - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="memoffset" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../memoffset/index.html">memoffset</a><span class="version">0.9.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">span_of</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#note" title="Note">Note</a></li><li><a href="#safety" title="Safety">Safety</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate memoffset</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">memoffset</a></span><h1>Macro <span class="macro">span_of</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/memoffset/span_of.rs.html#93-152">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! span_of {
|
||||
(@helper $root:ident, [] ..=) => { ... };
|
||||
(@helper $root:ident, [] ..) => { ... };
|
||||
(@helper $root:ident, $parent:path, [] ..) => { ... };
|
||||
(@helper $root:ident, $parent:path, [] ..= $end:tt) => { ... };
|
||||
(@helper $root:ident, $parent:path, [] .. $end:tt) => { ... };
|
||||
(@helper $root:ident, $parent:path, # $begin:tt [] ..= $end:tt) => { ... };
|
||||
(@helper $root:ident, $parent:path, # $begin:tt [] .. $end:tt) => { ... };
|
||||
(@helper $root:ident, $parent:path, # $begin:tt [] ..) => { ... };
|
||||
(@helper $root:ident, $parent:path, # $begin:tt [] ..=) => { ... };
|
||||
(@helper $root:ident, $parent:path, # $field:tt []) => { ... };
|
||||
(@helper $root:ident, $parent:path, $(# $begin:tt)+ [] $tt:tt $($rest:tt)*) => { ... };
|
||||
(@helper $root:ident, $parent:path, [] $tt:tt $($rest:tt)*) => { ... };
|
||||
($sty:path, $($exp:tt)+) => { ... };
|
||||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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.</p>
|
||||
|
||||
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="macro">span_of!</span>(Struct, member)</code></pre></div>
|
||||
<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="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="comment">// Exclusive
|
||||
</span><span class="macro">span_of!</span>(Struct, member_a .. member_b)
|
||||
<span class="comment">// Inclusive
|
||||
</span><span class="macro">span_of!</span>(Struct, member_a ..= member_b)
|
||||
|
||||
<span class="comment">// Open-ended ranges
|
||||
</span><span class="macro">span_of!</span>(Struct, .. end)
|
||||
<span class="macro">span_of!</span>(Struct, start ..)</code></pre></div>
|
||||
<h4 id="note"><a class="doc-anchor" href="#note">§</a>Note</h4>
|
||||
<p>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>
|
||||
<h4 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h4>
|
||||
<p>The inter-field form mentioned above assumes that the first field is positioned before the
|
||||
second.
|
||||
This is only guaranteed for <code>repr(C)</code> structs.
|
||||
Usage with <code>repr(Rust)</code> structs may yield unexpected results, like downward-going ranges,
|
||||
spans that include unexpected fields, empty spans, or spans that include <em>unexpected</em> padding bytes.</p>
|
||||
<h3 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h3>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>memoffset::span_of;
|
||||
|
||||
<span class="attr">#[repr(C)]
|
||||
</span><span class="kw">struct </span>Florp {
|
||||
a: u32
|
||||
}
|
||||
|
||||
<span class="attr">#[repr(C)]
|
||||
</span><span class="kw">struct </span>Blarg {
|
||||
x: [u32; <span class="number">2</span>],
|
||||
y: [u8; <span class="number">56</span>],
|
||||
z: Florp,
|
||||
egg: [[u8; <span class="number">4</span>]; <span class="number">4</span>]
|
||||
}
|
||||
|
||||
<span class="macro">assert_eq!</span>(<span class="number">0</span>..<span class="number">84</span>, <span class="macro">span_of!</span>(Blarg, ..));
|
||||
<span class="macro">assert_eq!</span>(<span class="number">0</span>..<span class="number">8</span>, <span class="macro">span_of!</span>(Blarg, .. y));
|
||||
<span class="macro">assert_eq!</span>(<span class="number">0</span>..<span class="number">64</span>, <span class="macro">span_of!</span>(Blarg, ..= y));
|
||||
<span class="macro">assert_eq!</span>(<span class="number">0</span>..<span class="number">8</span>, <span class="macro">span_of!</span>(Blarg, x));
|
||||
<span class="macro">assert_eq!</span>(<span class="number">8</span>..<span class="number">84</span>, <span class="macro">span_of!</span>(Blarg, y ..));
|
||||
<span class="macro">assert_eq!</span>(<span class="number">0</span>..<span class="number">8</span>, <span class="macro">span_of!</span>(Blarg, x .. y));
|
||||
<span class="macro">assert_eq!</span>(<span class="number">0</span>..<span class="number">64</span>, <span class="macro">span_of!</span>(Blarg, x ..= y));</code></pre></div>
|
||||
</div></details></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user