11 lines
6.2 KiB
HTML
11 lines
6.2 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="aligned-vec"><title>aligned_vec - 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="aligned_vec" 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="../crates.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 mod crate"><!--[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="#">Crate aligned_vec</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../aligned_vec/index.html">aligned_<wbr>vec</a><span class="version">0.6.4</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="#aligned-vec" title="aligned-vec">aligned-vec</a></li><li><a href="#features" title="Features">Features</a></li></ul><h3><a href="#macros">Crate Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>aligned_<wbr>vec</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/aligned_vec/lib.rs.html#1-1419">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="aligned-vec"><a class="doc-anchor" href="#aligned-vec">§</a>aligned-vec</h2>
|
|
<p>This crate provides the <code>AVec<T></code> and <code>ABox<T></code> types, which are intended to have a similar API
|
|
to <code>Vec<T></code> and <code>Box<T></code>, but align the data they contain to a runtime alignment value.</p>
|
|
<p>This is useful for situations where the alignment of the data matters, such as when working with
|
|
numerical data that can get performance benefits from being aligned to a SIMD-compatible memory address.</p>
|
|
<h2 id="features"><a class="doc-anchor" href="#features">§</a>Features</h2>
|
|
<ul>
|
|
<li><code>std</code> (default feature): Links this crate to the <code>std-crate</code> instead of the <code>core-crate</code>.</li>
|
|
<li><code>serde</code>: Implements serialization and deserialization features for <code>ABox</code> and <code>AVec</code>.</li>
|
|
</ul>
|
|
</div></details><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.avec.html" title="macro aligned_vec::avec">avec</a></dt><dd>Creates a <a href="struct.AVec.html" title="struct aligned_vec::AVec"><code>AVec</code></a> containing the arguments.</dd><dt><a class="macro" href="macro.avec_rt.html" title="macro aligned_vec::avec_rt">avec_rt</a></dt><dd>Create a vector that is aligned to a runtime alignment value.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.ABox.html" title="struct aligned_vec::ABox">ABox</a></dt><dd>Aligned box. See [<code>Box</code>] for more info.</dd><dt><a class="struct" href="struct.AVec.html" title="struct aligned_vec::AVec">AVec</a></dt><dd>Aligned vector. See [<code>Vec</code>] for more info.</dd><dt><a class="struct" href="struct.ConstAlign.html" title="struct aligned_vec::ConstAlign">Const<wbr>Align</a></dt><dd>Type wrapping a compile-time alignment value.</dd><dt><a class="struct" href="struct.RuntimeAlign.html" title="struct aligned_vec::RuntimeAlign">Runtime<wbr>Align</a></dt><dd>Type wrapping a runtime alignment value.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.TryReserveError.html" title="enum aligned_vec::TryReserveError">TryReserve<wbr>Error</a></dt></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.CACHELINE_ALIGN.html" title="constant aligned_vec::CACHELINE_ALIGN">CACHELINE_<wbr>ALIGN</a></dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Alignment.html" title="trait aligned_vec::Alignment">Alignment</a></dt><dd>Trait for types that wrap an alignment value.</dd></dl></section></div></main></body></html> |