mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 18:32:15 +00:00
35 lines
18 KiB
HTML
35 lines
18 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 `Plain` trait in crate `plain`."><meta name="keywords" content="rust, rustlang, rust-lang, Plain"><title>plain::Plain - 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 trait"><!--[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><p class='location'>Trait Plain</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.copy_from_bytes">copy_from_bytes</a><a href="#method.from_bytes">from_bytes</a><a href="#method.from_mut_bytes">from_mut_bytes</a><a href="#method.slice_from_bytes">slice_from_bytes</a><a href="#method.slice_from_bytes_len">slice_from_bytes_len</a><a href="#method.slice_from_mut_bytes">slice_from_mut_bytes</a><a href="#method.slice_from_mut_bytes_len">slice_from_mut_bytes_len</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>plain</a></p><script>window.sidebarCurrent = {name: 'Plain', ty: 'trait', 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/plain.rs.html#25-78' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>plain</a>::<wbr><a class="trait" href=''>Plain</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait Plain {
|
||
fn <a href='#method.from_bytes' class='fnname'>from_bytes</a>(bytes: &[u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&Self, <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.slice_from_bytes' class='fnname'>slice_from_bytes</a>(bytes: &[u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&[Self], <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.slice_from_bytes_len' class='fnname'>slice_from_bytes_len</a>(bytes: &[u8], len: usize) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&[Self], <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.from_mut_bytes' class='fnname'>from_mut_bytes</a>(bytes: &mut [u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&mut Self, <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.slice_from_mut_bytes' class='fnname'>slice_from_mut_bytes</a>(bytes: &mut [u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&mut [Self], <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.slice_from_mut_bytes_len' class='fnname'>slice_from_mut_bytes_len</a>(<br> bytes: &mut [u8], <br> len: usize<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&mut [Self], <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.copy_from_bytes' class='fnname'>copy_from_bytes</a>(&mut self, bytes: &[u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(), <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>> { ... }
|
||
}</pre></div><div class='docblock'><p>A trait for plain data types that can be safely read from a byte slice.</p>
|
||
<p>A type can be <a href="trait.Plain.html"><code>Plain</code></a> if it is <code>#repr(C)</code> and only contains
|
||
data with no possible invalid values. Types that <em>can't</em> be <code>Plain</code>
|
||
include, but are not limited to, <code>bool</code>, <code>char</code>, <code>enum</code>s, tuples,
|
||
pointers and references.</p>
|
||
<p>At this moment, <code>Drop</code> types are also not legal, because
|
||
compiler adds a special "drop flag" into the type. This is slated
|
||
to change in the future.</p>
|
||
<p>On the other hand, arrays of a <code>Plain</code> type, and
|
||
structures where all members are plain (and not <code>Drop</code>), are okay.</p>
|
||
<p>Structures that are not <code>#repr(C)</code>, while not necessarily illegal
|
||
in principle, are largely useless because they don't have a stable
|
||
layout. For example, the compiler is allowed to reorder fields
|
||
arbitrarily.</p>
|
||
<p>All methods of this trait are implemented automatically as wrappers
|
||
for crate-level funtions.</p>
|
||
</div>
|
||
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.from_bytes' class='method'><code id='from_bytes.v'>fn <a href='#method.from_bytes' class='fnname'>from_bytes</a>(bytes: &[u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&Self, <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><h3 id='method.slice_from_bytes' class='method'><code id='slice_from_bytes.v'>fn <a href='#method.slice_from_bytes' class='fnname'>slice_from_bytes</a>(bytes: &[u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&[Self], <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><h3 id='method.slice_from_bytes_len' class='method'><code id='slice_from_bytes_len.v'>fn <a href='#method.slice_from_bytes_len' class='fnname'>slice_from_bytes_len</a>(bytes: &[u8], len: usize) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&[Self], <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><h3 id='method.from_mut_bytes' class='method'><code id='from_mut_bytes.v'>fn <a href='#method.from_mut_bytes' class='fnname'>from_mut_bytes</a>(bytes: &mut [u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&mut Self, <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><h3 id='method.slice_from_mut_bytes' class='method'><code id='slice_from_mut_bytes.v'>fn <a href='#method.slice_from_mut_bytes' class='fnname'>slice_from_mut_bytes</a>(bytes: &mut [u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&mut [Self], <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><h3 id='method.slice_from_mut_bytes_len' class='method'><code id='slice_from_mut_bytes_len.v'>fn <a href='#method.slice_from_mut_bytes_len' class='fnname'>slice_from_mut_bytes_len</a>(<br> bytes: &mut [u8], <br> len: usize<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&mut [Self], <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><h3 id='method.copy_from_bytes' class='method'><code id='copy_from_bytes.v'>fn <a href='#method.copy_from_bytes' class='fnname'>copy_from_bytes</a>(&mut self, bytes: &[u8]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(), <a class="enum" href="../plain/enum.Error.html" title="enum plain::Error">Error</a>></code></h3></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Plain' class='impl'><code class='in-band'>impl Plain for i8</code><a href='#impl-Plain' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#86' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-1' class='impl'><code class='in-band'>impl Plain for i16</code><a href='#impl-Plain-1' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#87' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-2' class='impl'><code class='in-band'>impl Plain for i32</code><a href='#impl-Plain-2' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#88' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-3' class='impl'><code class='in-band'>impl Plain for i64</code><a href='#impl-Plain-3' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#89' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-4' class='impl'><code class='in-band'>impl Plain for isize</code><a href='#impl-Plain-4' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#90' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-5' class='impl'><code class='in-band'>impl Plain for u8</code><a href='#impl-Plain-5' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#80' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-6' class='impl'><code class='in-band'>impl Plain for u16</code><a href='#impl-Plain-6' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#81' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-7' class='impl'><code class='in-band'>impl Plain for u32</code><a href='#impl-Plain-7' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#82' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-8' class='impl'><code class='in-band'>impl Plain for u64</code><a href='#impl-Plain-8' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#83' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-9' class='impl'><code class='in-band'>impl Plain for usize</code><a href='#impl-Plain-9' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#84' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Plain-10' class='impl'><code class='in-band'>impl<S> Plain for [S] <span class="where fmt-newline">where<br> S: <a class="trait" href="../plain/trait.Plain.html" title="trait plain::Plain">Plain</a>, </span></code><a href='#impl-Plain-10' class='anchor'></a><a class='srclink' href='../src/plain/plain.rs.html#92-96' title='goto source code'>[src]</a></h3><div class='impl-items'></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/plain/trait.Plain.js">
|
||
</script></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> |