mirror of
https://github.com/fluencelabs/wasmer
synced 2025-05-17 04:51:18 +00:00
38 lines
9.8 KiB
HTML
38 lines
9.8 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 `bincode` crate."><meta name="keywords" content="rust, rustlang, rust-lang, bincode"><title>bincode - 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 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='../bincode/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate bincode</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all bincode's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'bincode', 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 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/bincode/lib.rs.html#1-173' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>bincode</a></span></h1><div class='docblock'><p>Bincode is a crate for encoding and decoding using a tiny binary
|
||
serialization strategy. Using it, you can easily go from having
|
||
an object in memory, quickly serialize it to bytes, and then
|
||
deserialize it back just as fast!</p>
|
||
<h3 id="using-basic-functions" class="section-header"><a href="#using-basic-functions">Using Basic Functions</a></h3>
|
||
<div class='information'><div class='tooltip edition'>ⓘ<span class='tooltiptext'>This code runs with edition 2018</span></div></div><div class="example-wrap"><pre class="rust rust-example-rendered edition ">
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="comment">// The object that we will serialize.</span>
|
||
<span class="kw">let</span> <span class="ident">target</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="string">"hello world"</span>.<span class="ident">to_string</span>());
|
||
|
||
<span class="kw">let</span> <span class="ident">encoded</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="ident">bincode</span>::<span class="ident">serialize</span>(<span class="kw-2">&</span><span class="ident">target</span>).<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">decoded</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> <span class="op">=</span> <span class="ident">bincode</span>::<span class="ident">deserialize</span>(<span class="kw-2">&</span><span class="ident">encoded</span>[..]).<span class="ident">unwrap</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">target</span>, <span class="ident">decoded</span>);
|
||
}</pre></div>
|
||
<h3 id="128bit-numbers" class="section-header"><a href="#128bit-numbers">128bit numbers</a></h3>
|
||
<p>Support for <code>i128</code> and <code>u128</code> is automatically enabled on Rust toolchains
|
||
greater than or equal to <code>1.26.0</code>.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Config.html" title='bincode::Config struct'>Config</a></td><td class='docblock-short'><p>A configuration builder whose options Bincode will use
|
||
while serializing and deserializing.</p>
|
||
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.ErrorKind.html" title='bincode::ErrorKind enum'>ErrorKind</a></td><td class='docblock-short'><p>The kind of error that can be produced during a serialization or deserialization.</p>
|
||
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.BincodeRead.html" title='bincode::BincodeRead trait'>BincodeRead</a></td><td class='docblock-short'><p>An optional Read trait for advanced Bincode usage.</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.config.html" title='bincode::config fn'>config</a></td><td class='docblock-short'><p>Get a default configuration object.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.deserialize.html" title='bincode::deserialize fn'>deserialize</a></td><td class='docblock-short'><p>Deserializes a slice of bytes into an instance of <code>T</code> using the default configuration.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.deserialize_from.html" title='bincode::deserialize_from fn'>deserialize_from</a></td><td class='docblock-short'><p>Deserializes an object directly from a <code>Read</code>er using the default configuration.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.deserialize_from_custom.html" title='bincode::deserialize_from_custom fn'>deserialize_from_custom</a></td><td class='docblock-short'><p>Deserializes an object from a custom <code>BincodeRead</code>er using the default configuration.
|
||
It is highly recommended to use <code>deserialize_from</code> unless you need to implement
|
||
<code>BincodeRead</code> for performance reasons.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.serialize.html" title='bincode::serialize fn'>serialize</a></td><td class='docblock-short'><p>Serializes a serializable object into a <code>Vec</code> of bytes using the default configuration.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.serialize_into.html" title='bincode::serialize_into fn'>serialize_into</a></td><td class='docblock-short'><p>Serializes an object directly into a <code>Writer</code> using the default configuration.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.serialized_size.html" title='bincode::serialized_size fn'>serialized_size</a></td><td class='docblock-short'><p>Returns the size that an object would be if serialized using Bincode with the default configuration.</p>
|
||
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table><tr class='module-item'><td><a class="type" href="type.Error.html" title='bincode::Error type'>Error</a></td><td class='docblock-short'><p>An error that can be produced during (de)serializing.</p>
|
||
</td></tr><tr class='module-item'><td><a class="type" href="type.Result.html" title='bincode::Result type'>Result</a></td><td class='docblock-short'><p>The result of a serialization or deserialization operation.</p>
|
||
</td></tr></table></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 = "bincode";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |