41 lines
7.0 KiB
HTML
41 lines
7.0 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="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)."><title>arrayref - 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-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="arrayref" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.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 mod crate"><!--[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="../arrayref/index.html">arrayref</a><span class="version">0.3.9</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#macros">Crate Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>arrayref</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/arrayref/lib.rs.html#1-504">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<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"><code><span class="attr">#[macro_use]
|
|
</span><span class="kw">extern crate </span>arrayref;
|
|
|
|
<span class="kw">fn </span>read_u16(bytes: <span class="kw-2">&</span>[u8; <span class="number">2</span>]) -> u16 {
|
|
bytes[<span class="number">0</span>] <span class="kw">as </span>u16 + ((bytes[<span class="number">1</span>] <span class="kw">as </span>u16) << <span class="number">8</span>)
|
|
}
|
|
<span class="comment">// ...
|
|
</span><span class="kw">let </span>data = [<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="number">256</span>, read_u16(<span class="macro">array_ref!</span>[data,<span class="number">0</span>,<span class="number">2</span>]));
|
|
<span class="macro">assert_eq!</span>(<span class="number">4</span>, read_u16(<span class="macro">array_ref!</span>[data,<span class="number">4</span>,<span class="number">2</span>]));</code></pre></div>
|
|
</div></details><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.array_mut_ref.html" title="macro arrayref::array_mut_ref">array_<wbr>mut_<wbr>ref</a></div><div class="desc docblock-short">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).</div></li><li><div class="item-name"><a class="macro" href="macro.array_ref.html" title="macro arrayref::array_ref">array_<wbr>ref</a></div><div class="desc docblock-short">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).</div></li><li><div class="item-name"><a class="macro" href="macro.array_refs.html" title="macro arrayref::array_refs">array_<wbr>refs</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="macro" href="macro.mut_array_refs.html" title="macro arrayref::mut_array_refs">mut_<wbr>array_<wbr>refs</a></div><div class="desc docblock-short">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.</div></li></ul></section></div></main></body></html> |