mirror of
https://github.com/fluencelabs/wasmer
synced 2025-05-07 00:02:14 +00:00
47 lines
8.6 KiB
HTML
47 lines
8.6 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 `arrayref` crate."><meta name="keywords" content="rust, rustlang, rust-lang, arrayref"><title>arrayref - 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='../arrayref/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate arrayref</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all arrayref's items</p></a><div class="block items"><ul><li><a href="#macros">Macros</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'arrayref', ty: 'mod', relpath: '../'};</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/arrayref/lib.rs.html#1-472' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>arrayref</a></span></h1><div class='docblock'><p>This package contains just four macros, which enable the creation
|
||
of array references to portions of arrays or slices (or things
|
||
that can be sliced).</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>Here is a simple example of slicing and dicing a slice into array
|
||
references with these macros. Here we implement a simple
|
||
little-endian conversion from bytes to <code>u16</code>, and demonstrate code
|
||
that uses <code>array_ref!</code> to extract an array reference from a larger
|
||
array. Note that the documentation for each macro also has an
|
||
example of its use.</p>
|
||
|
||
<div class="example-wrap"><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">arrayref</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">read_u16</span>(<span class="ident">bytes</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>; <span class="number">2</span>]) <span class="op">-</span><span class="op">></span> <span class="ident">u16</span> {
|
||
<span class="ident">bytes</span>[<span class="number">0</span>] <span class="kw">as</span> <span class="ident">u16</span> <span class="op">+</span> ((<span class="ident">bytes</span>[<span class="number">1</span>] <span class="kw">as</span> <span class="ident">u16</span>) <span class="op"><</span><span class="op"><</span> <span class="number">8</span>)
|
||
}
|
||
<span class="comment">// ...</span>
|
||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> [<span class="number">0</span>,<span class="number">1</span>,<span class="number">2</span>,<span class="number">3</span>,<span class="number">4</span>,<span class="number">0</span>,<span class="number">6</span>,<span class="number">7</span>,<span class="number">8</span>,<span class="number">9</span>];
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">256</span>, <span class="ident">read_u16</span>(<span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>,<span class="number">0</span>,<span class="number">2</span>]));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">4</span>, <span class="ident">read_u16</span>(<span class="macro">array_ref</span><span class="macro">!</span>[<span class="ident">data</span>,<span class="number">4</span>,<span class="number">2</span>]));</pre></div>
|
||
</div><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
|
||
<table><tr class='module-item'><td><a class="macro" href="macro.array_mut_ref.html" title='arrayref::array_mut_ref macro'>array_mut_ref</a></td><td class='docblock-short'><p>You can use <code>array_mut_ref</code> to generate a mutable array reference
|
||
to a subset of a sliceable bit of data (which could be an array,
|
||
or a slice, or a Vec).</p>
|
||
</td></tr><tr class='module-item'><td><a class="macro" href="macro.array_ref.html" title='arrayref::array_ref macro'>array_ref</a></td><td class='docblock-short'><p>You can use <code>array_ref</code> to generate an array reference to a subset
|
||
of a sliceable bit of data (which could be an array, or a slice,
|
||
or a Vec).</p>
|
||
</td></tr><tr class='module-item'><td><a class="macro" href="macro.array_refs.html" title='arrayref::array_refs macro'>array_refs</a></td><td class='docblock-short'><p>You can use <code>array_refs</code> to generate a series of array references
|
||
to an input array reference. The idea is if you want to break an
|
||
array into a series of contiguous and non-overlapping arrays.
|
||
<code>array_refs</code> is a bit funny in that it insists on slicing up the
|
||
<em>entire</em> array. This is intentional, as I find it handy to make
|
||
me ensure that my sub-arrays add up to the entire array. This
|
||
macro will <em>never</em> panic, since the sizes are all checked at
|
||
compile time.</p>
|
||
</td></tr><tr class='module-item'><td><a class="macro" href="macro.mut_array_refs.html" title='arrayref::mut_array_refs macro'>mut_array_refs</a></td><td class='docblock-short'><p>You can use <code>mut_array_refs</code> to generate a series of mutable array
|
||
references to an input mutable array reference. The idea is if
|
||
you want to break an array into a series of contiguous and
|
||
non-overlapping mutable array references. Like <code>array_refs!</code>,
|
||
<code>mut_array_refs!</code> is a bit funny in that it insists on slicing up
|
||
the <em>entire</em> array. This is intentional, as I find it handy to
|
||
make me ensure that my sub-arrays add up to the entire array.
|
||
This macro will <em>never</em> panic, since the sizes are all checked at
|
||
compile time.</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 = "arrayref";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |