33 lines
6.1 KiB
HTML
33 lines
6.1 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="Convenience wrapper for `ZeroSlice::from_ule_slice`. The value will be created at compile-time, meaning that all arguments must also be constant."><title>zeroslice in zerovec - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="zerovec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.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]--><rustdoc-topbar><h2><a href="#">zeroslice</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../zerovec/index.html">zerovec</a><span class="version">0.11.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">zeroslice</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#arguments" title="Arguments">Arguments</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 zerovec</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">zerovec</a></div><h1>Macro <span class="macro">zeroslice</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/zerovec/zerovec/mod.rs.html#1180-1187">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! zeroslice {
|
|
() => { ... };
|
|
($aligned:ty; $convert:expr; [$($x:expr),+ $(,)?]) => { ... };
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Convenience wrapper for <a href="struct.ZeroSlice.html#method.from_ule_slice" title="associated function zerovec::ZeroSlice::from_ule_slice"><code>ZeroSlice::from_ule_slice</code></a>. The value will be created at compile-time,
|
|
meaning that all arguments must also be constant.</p>
|
|
<h2 id="arguments"><a class="doc-anchor" href="#arguments">§</a>Arguments</h2>
|
|
<ul>
|
|
<li><code>$aligned</code> - The type of an element in its canonical, aligned form, e.g., <code>char</code>.</li>
|
|
<li><code>$convert</code> - A const function that converts an <code>$aligned</code> into its unaligned equivalent, e.g.,
|
|
const fn from_aligned(a: CanonicalType) -> CanonicalType::ULE`.</li>
|
|
<li><code>$x</code> - The elements that the <code>ZeroSlice</code> will hold.</li>
|
|
</ul>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<p>Using array-conversion functions provided by this crate:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerovec::{ZeroSlice, zeroslice, ule::AsULE};
|
|
|
|
<span class="kw">const </span>SIGNATURE: <span class="kw-2">&</span>ZeroSlice<char> = <span class="macro">zeroslice!</span>(char; <char <span class="kw">as </span>AsULE>::ULE::from_aligned; [<span class="string">'b'</span>, <span class="string">'y'</span>, <span class="string">'e'</span>, <span class="string">'✌'</span>]);
|
|
<span class="kw">const </span>EMPTY: <span class="kw-2">&</span>ZeroSlice<u32> = <span class="macro">zeroslice!</span>[];
|
|
|
|
<span class="kw">let </span>empty: <span class="kw-2">&</span>ZeroSlice<u32> = <span class="macro">zeroslice!</span>[];
|
|
<span class="kw">let </span>nums = <span class="macro">zeroslice!</span>(u32; <u32 <span class="kw">as </span>AsULE>::ULE::from_unsigned; [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);
|
|
<span class="macro">assert_eq!</span>(nums.last().unwrap(), <span class="number">5</span>);</code></pre></div>
|
|
<p>Using a custom array-conversion function:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>zerovec::{ule::AsULE, ule::RawBytesULE, zeroslice, ZeroSlice};
|
|
|
|
<span class="kw">const fn </span>be_convert(num: i16) -> <i16 <span class="kw">as </span>AsULE>::ULE {
|
|
RawBytesULE(num.to_be_bytes())
|
|
}
|
|
|
|
<span class="kw">const </span>NUMBERS_BE: <span class="kw-2">&</span>ZeroSlice<i16> =
|
|
<span class="macro">zeroslice!</span>(i16; be_convert; [<span class="number">1</span>, -<span class="number">2</span>, <span class="number">3</span>, -<span class="number">4</span>, <span class="number">5</span>]);</code></pre></div></div></details></section></div></main></body></html> |