mirror of
https://github.com/rust-embedded/heapless.git
synced 2025-09-30 05:50:29 +00:00
17 lines
4.7 KiB
HTML
17 lines
4.7 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 `as_slice` crate."><meta name="keywords" content="rust, rustlang, rust-lang, as_slice"><title>as_slice - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><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='../as_slice/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate as_slice</p><div class='block version'><p>Version 0.1.4</p></div><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all as_slice's items</p></a><div class="block items"><ul><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'as_slice', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
|
||
<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/as_slice/lib.rs.html#1-196' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>as_slice</a></span></h1><div class='docblock'><p><code>AsSlice</code> and <code>AsMutSlice</code> traits</p>
|
||
<p>These traits are somewhat similar to the <code>AsRef</code> and <code>AsMut</code> except that they are <strong>NOT</strong>
|
||
polymorphic (no input type parameter) and their methods always return slices (<code>[T]</code>).</p>
|
||
<p>The main use case of these traits is writing generic code that accepts (fixed size) buffers. For
|
||
example, a bound <code>T: StableDeref + AsMutSlice<Element = u8> + 'static</code> will accepts types like
|
||
<code>&'static mut [u8]</code>, <code>&'static mut [u8; 128]</code> and <code>&'static mut GenericArray<u8, U1024></code> -- all
|
||
of them are appropriate for DMA transfers.</p>
|
||
<h1 id="minimal-supported-rust-version-msrv" class="section-header"><a href="#minimal-supported-rust-version-msrv">Minimal Supported Rust Version (MSRV)</a></h1>
|
||
<p>This crate is guaranteed to compile on stable Rust 1.31 and up. It <em>might</em> compile on older
|
||
versions but that may change in any new patch release.</p>
|
||
</div><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.AsMutSlice.html" title='as_slice::AsMutSlice trait'>AsMutSlice</a></td><td class='docblock-short'><p>Something that can be seen as an mutable slice</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.AsSlice.html" title='as_slice::AsSlice trait'>AsSlice</a></td><td class='docblock-short'><p>Something that can be seen as an immutable slice</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "as_slice";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |