mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-26 19:02:13 +00:00
22 lines
5.5 KiB
HTML
22 lines
5.5 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 `slice_from_bytes` fn in crate `plain`."><meta name="keywords" content="rust, rustlang, rust-lang, slice_from_bytes"><title>plain::slice_from_bytes - 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 fn"><!--[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='../plain/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>plain</a></p><script>window.sidebarCurrent = {name: 'slice_from_bytes', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></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/plain/methods.rs.html#106-112' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>plain</a>::<wbr><a class="fn" href=''>slice_from_bytes</a></span></h1><pre class='rust fn'>pub fn slice_from_bytes<T>(bytes: &[u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&[T], <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../plain/trait.Plain.html" title="trait plain::Plain">Plain</a>, </span></pre><div class='docblock'><p>Similar to <a href="fn.from_bytes.html"><code>from_bytes()</code></a>,
|
||
except that the output is a slice of T, instead
|
||
of a reference to a single T. All concerns about
|
||
alignment also apply here, but size is handled
|
||
differently.</p>
|
||
<p>The result slice's length is set to be
|
||
<code>bytes.len() / size_of::<T>()</code>, and there
|
||
are no requirements for input size. I.e.
|
||
the result may be empty slice, and the input
|
||
slice doesn't necessarily have to end on <code>T</code>'s
|
||
boundary. The latter has pragmatic reasons: If the
|
||
length of the array is not known in advance,
|
||
e.g. if it's terminated by a special element,
|
||
it's perfectly legal to turn the whole rest
|
||
of data into <code>&[T]</code> and set the proper length
|
||
after inspecting the array.</p>
|
||
<p>In many cases it is preferrable to allocate
|
||
a value/slice of the target type and use
|
||
<a href="fn.copy_from_bytes.html"><code>copy_from_bytes()</code></a> to copy
|
||
data instead. That way, any issues with alignment
|
||
are implicitly avoided.</p>
|
||
</div></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 = "plain";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |