mirror of
https://github.com/fluencelabs/wasmer
synced 2025-04-25 10:22:19 +00:00
33 lines
7.9 KiB
HTML
33 lines
7.9 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 `serde_bytes` crate."><meta name="keywords" content="rust, rustlang, rust-lang, serde_bytes"><title>serde_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 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='../serde_bytes/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate serde_bytes</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all serde_bytes's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'serde_bytes', 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/serde_bytes/lib.rs.html#1-108' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>serde_bytes</a></span></h1><div class='docblock'><p>Wrapper types to enable optimized handling of <code>&[u8]</code> and <code>Vec<u8></code>.</p>
|
||
<p>Without specialization, Rust forces Serde to treat <code>&[u8]</code> just like any
|
||
other slice and <code>Vec<u8></code> just like any other vector. In reality this
|
||
particular slice and vector can often be serialized and deserialized in a
|
||
more efficient, compact representation in many formats.</p>
|
||
<p>When working with such a format, you can opt into specialized handling of
|
||
<code>&[u8]</code> by wrapping it in <code>serde_bytes::Bytes</code> and <code>Vec<u8></code> by wrapping it
|
||
in <code>serde_bytes::ByteBuf</code>.</p>
|
||
<p>Additionally this crate supports the Serde <code>with</code> attribute to enable
|
||
efficient handling of <code>&[u8]</code> and <code>Vec<u8></code> in structs without needing a
|
||
wrapper type.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>)]</span>
|
||
<span class="kw">struct</span> <span class="ident">Efficient</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
||
<span class="attribute">#[<span class="ident">serde</span>(<span class="ident">with</span> <span class="op">=</span> <span class="string">"serde_bytes"</span>)]</span>
|
||
<span class="ident">bytes</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">u8</span>],
|
||
|
||
<span class="attribute">#[<span class="ident">serde</span>(<span class="ident">with</span> <span class="op">=</span> <span class="string">"serde_bytes"</span>)]</span>
|
||
<span class="ident">byte_buf</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>,
|
||
}</pre></div>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.ByteBuf.html" title='serde_bytes::ByteBuf struct'>ByteBuf</a></td><td class='docblock-short'><p>Wrapper around <code>Vec<u8></code> to serialize and deserialize efficiently.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Bytes.html" title='serde_bytes::Bytes struct'>Bytes</a></td><td class='docblock-short'><p>Wrapper around <code>&[u8]</code> to serialize and deserialize efficiently.</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.Deserialize.html" title='serde_bytes::Deserialize trait'>Deserialize</a></td><td class='docblock-short'><p>Types that can be deserialized via <code>#[serde(with = "serde_bytes")]</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Serialize.html" title='serde_bytes::Serialize trait'>Serialize</a></td><td class='docblock-short'><p>Types that can be serialized via <code>#[serde(with = "serde_bytes")]</code>.</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.deserialize.html" title='serde_bytes::deserialize fn'>deserialize</a></td><td class='docblock-short'><p>Serde <code>deserialize_with</code> function to deserialize bytes efficiently.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.serialize.html" title='serde_bytes::serialize fn'>serialize</a></td><td class='docblock-short'><p>Serde <code>serialize_with</code> function to serialize bytes efficiently.</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 = "serde_bytes";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |