NotAShelf/mpvrc
1
0
Fork 0
mirror of https://github.com/NotAShelf/mpvrc.git synced 2026-04-17 08:19:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

deploy: de38ae62916547ad097c066f94a32e9ba7790eeb

Browse source
This commit is contained in:
NotAShelf 2025-02-05 00:10:33 +00:00
commit 9a86359447
28502 changed files with 1261284 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
bincode/all.html Normal file
View file

File diff suppressed because one or more lines are too long

11
bincode/config/endian/struct.BigEndian.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.BigEndian.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.BigEndian.html">../../../bincode/config/struct.BigEndian.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.BigEndian.html" + location.search + location.hash);</script>
</body>
</html>

11
bincode/config/endian/struct.LittleEndian.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.LittleEndian.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.LittleEndian.html">../../../bincode/config/struct.LittleEndian.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.LittleEndian.html" + location.search + location.hash);</script>
</body>
</html>

11
bincode/config/endian/struct.NativeEndian.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.NativeEndian.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.NativeEndian.html">../../../bincode/config/struct.NativeEndian.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.NativeEndian.html" + location.search + location.hash);</script>
</body>
</html>

26
bincode/config/index.html Normal file
View file

@ -0,0 +1,26 @@
<!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="`bincode` uses a Builder-pattern to configure the Serializers and Deserializers in this crate. This means that if you need to customize the behavior of `bincode`, you should create an instance of the `DefaultOptions` struct:"><title>bincode::config - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module config</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#options-struct-vs-bincode-functions" title="Options Struct vs bincode functions">Options Struct vs bincode functions</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bincode</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">bincode</a></span><h1>Module <span>config</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bincode/config/mod.rs.html#1-408">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>bincode</code> uses a Builder-pattern to configure the Serializers and Deserializers in this
crate. This means that if you need to customize the behavior of <code>bincode</code>, you should create an
instance of the <code>DefaultOptions</code> struct:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bincode::Options;
<span class="kw">let </span>my_options = bincode::DefaultOptions::new();</code></pre></div>
<h2 id="options-struct-vs-bincode-functions"><a class="doc-anchor" href="#options-struct-vs-bincode-functions">§</a>Options Struct vs bincode functions</h2>
<p>Due to historical reasons, the default options used by the <code>serialize()</code> and <code>deserialize()</code>
family of functions are different than the default options created by the <code>DefaultOptions</code> struct:</p>
<div><table><thead><tr><th></th><th>Byte limit</th><th>Endianness</th><th>Int Encoding</th><th>Trailing Behavior</th></tr></thead><tbody>
<tr><td>struct</td><td>Unlimited</td><td>Little</td><td>Varint</td><td>Reject</td></tr>
<tr><td>function</td><td>Unlimited</td><td>Little</td><td>Fixint</td><td>Allow</td></tr>
</tbody></table>
</div>
<p>This means that if you want to use the <code>Serialize</code> / <code>Deserialize</code> structs with the same
settings as the functions, you should adjust the <code>DefaultOptions</code> struct like so:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bincode::Options;
<span class="kw">let </span>my_options = bincode::DefaultOptions::new()
.with_fixint_encoding()
.allow_trailing_bytes();</code></pre></div>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AllowTrailing.html" title="struct bincode::config::AllowTrailing">Allow<wbr>Trailing</a></div><div class="desc docblock-short">A TrailingBytes config that will allow trailing bytes in slices after deserialization.</div></li><li><div class="item-name"><a class="struct" href="struct.BigEndian.html" title="struct bincode::config::BigEndian">BigEndian</a></div><div class="desc docblock-short">Big-endian byte ordering.</div></li><li><div class="item-name"><a class="struct" href="struct.Bounded.html" title="struct bincode::config::Bounded">Bounded</a></div><div class="desc docblock-short">A SizeLimit that restricts serialized or deserialized messages from
exceeding a certain byte length.</div></li><li><div class="item-name"><a class="struct" href="struct.Config.html" title="struct bincode::config::Config">Config</a><wbr><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">A configuration builder whose options Bincode will use
while serializing and deserializing.</div></li><li><div class="item-name"><a class="struct" href="struct.DefaultOptions.html" title="struct bincode::config::DefaultOptions">Default<wbr>Options</a></div><div class="desc docblock-short">The default options for bincode serialization/deserialization.</div></li><li><div class="item-name"><a class="struct" href="struct.FixintEncoding.html" title="struct bincode::config::FixintEncoding">Fixint<wbr>Encoding</a></div><div class="desc docblock-short">Fixed-size integer encoding.</div></li><li><div class="item-name"><a class="struct" href="struct.Infinite.html" title="struct bincode::config::Infinite">Infinite</a></div><div class="desc docblock-short">A SizeLimit without a limit!
Use this if you don’t care about the size of encoded or decoded messages.</div></li><li><div class="item-name"><a class="struct" href="struct.LittleEndian.html" title="struct bincode::config::LittleEndian">Little<wbr>Endian</a></div><div class="desc docblock-short">Little-endian byte ordering.</div></li><li><div class="item-name"><a class="struct" href="struct.NativeEndian.html" title="struct bincode::config::NativeEndian">Native<wbr>Endian</a></div><div class="desc docblock-short">The native byte ordering of the current system.</div></li><li><div class="item-name"><a class="struct" href="struct.RejectTrailing.html" title="struct bincode::config::RejectTrailing">Reject<wbr>Trailing</a></div><div class="desc docblock-short">A TrailingBytes config that will cause bincode to produce an error if bytes are left over in the slice when deserialization is complete.</div></li><li><div class="item-name"><a class="struct" href="struct.VarintEncoding.html" title="struct bincode::config::VarintEncoding">Varint<wbr>Encoding</a></div><div class="desc docblock-short">Variable-size integer encoding (excepting [ui]8).</div></li><li><div class="item-name"><a class="struct" href="struct.WithOtherEndian.html" title="struct bincode::config::WithOtherEndian">With<wbr>Other<wbr>Endian</a></div><div class="desc docblock-short">A configuration struct with a user-specified endian order</div></li><li><div class="item-name"><a class="struct" href="struct.WithOtherIntEncoding.html" title="struct bincode::config::WithOtherIntEncoding">With<wbr>Other<wbr>IntEncoding</a></div><div class="desc docblock-short">A configuration struct with a user-specified length encoding</div></li><li><div class="item-name"><a class="struct" href="struct.WithOtherLimit.html" title="struct bincode::config::WithOtherLimit">With<wbr>Other<wbr>Limit</a></div><div class="desc docblock-short">A configuration struct with a user-specified byte limit</div></li><li><div class="item-name"><a class="struct" href="struct.WithOtherTrailing.html" title="struct bincode::config::WithOtherTrailing">With<wbr>Other<wbr>Trailing</a></div><div class="desc docblock-short">A configuration struct with a user-specified trailing bytes behavior.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Options.html" title="trait bincode::config::Options">Options</a></div><div class="desc docblock-short">A configuration builder trait whose options Bincode will use
while serializing and deserializing.</div></li></ul></section></div></main></body></html>

11
bincode/config/int/struct.FixintEncoding.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.FixintEncoding.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.FixintEncoding.html">../../../bincode/config/struct.FixintEncoding.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.FixintEncoding.html" + location.search + location.hash);</script>
</body>
</html>

11
bincode/config/int/struct.VarintEncoding.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.VarintEncoding.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.VarintEncoding.html">../../../bincode/config/struct.VarintEncoding.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.VarintEncoding.html" + location.search + location.hash);</script>
</body>
</html>

11
bincode/config/legacy/struct.Config.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.Config.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.Config.html">../../../bincode/config/struct.Config.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.Config.html" + location.search + location.hash);</script>
</body>
</html>

11
bincode/config/limit/struct.Bounded.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.Bounded.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.Bounded.html">../../../bincode/config/struct.Bounded.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.Bounded.html" + location.search + location.hash);</script>
</body>
</html>

11
bincode/config/limit/struct.Infinite.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.Infinite.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.Infinite.html">../../../bincode/config/struct.Infinite.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.Infinite.html" + location.search + location.hash);</script>
</body>
</html>

1
bincode/config/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["AllowTrailing","BigEndian","Bounded","Config","DefaultOptions","FixintEncoding","Infinite","LittleEndian","NativeEndian","RejectTrailing","VarintEncoding","WithOtherEndian","WithOtherIntEncoding","WithOtherLimit","WithOtherTrailing"],"trait":["Options"]};

14
bincode/config/struct.AllowTrailing.html Normal file
View file

File diff suppressed because one or more lines are too long

14
bincode/config/struct.BigEndian.html Normal file
View file

File diff suppressed because one or more lines are too long

15
bincode/config/struct.Bounded.html Normal file
View file

File diff suppressed because one or more lines are too long

71
bincode/config/struct.Config.html Normal file
View file

File diff suppressed because one or more lines are too long

57
bincode/config/struct.DefaultOptions.html Normal file
View file

File diff suppressed because one or more lines are too long

19
bincode/config/struct.FixintEncoding.html Normal file
View file

File diff suppressed because one or more lines are too long

15
bincode/config/struct.Infinite.html Normal file
View file

File diff suppressed because one or more lines are too long

14
bincode/config/struct.LittleEndian.html Normal file
View file

File diff suppressed because one or more lines are too long

14
bincode/config/struct.NativeEndian.html Normal file
View file

File diff suppressed because one or more lines are too long

14
bincode/config/struct.RejectTrailing.html Normal file
View file

File diff suppressed because one or more lines are too long

47
bincode/config/struct.VarintEncoding.html Normal file
View file

File diff suppressed because one or more lines are too long

51
bincode/config/struct.WithOtherEndian.html Normal file
View file

File diff suppressed because one or more lines are too long

51
bincode/config/struct.WithOtherIntEncoding.html Normal file
View file

File diff suppressed because one or more lines are too long

52
bincode/config/struct.WithOtherLimit.html Normal file
View file

File diff suppressed because one or more lines are too long

51
bincode/config/struct.WithOtherTrailing.html Normal file
View file

File diff suppressed because one or more lines are too long

11
bincode/config/trailing/struct.AllowTrailing.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.AllowTrailing.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.AllowTrailing.html">../../../bincode/config/struct.AllowTrailing.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.AllowTrailing.html" + location.search + location.hash);</script>
</body>
</html>

11
bincode/config/trailing/struct.RejectTrailing.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../bincode/config/struct.RejectTrailing.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../bincode/config/struct.RejectTrailing.html">../../../bincode/config/struct.RejectTrailing.html</a>...</p>
<script>location.replace("../../../bincode/config/struct.RejectTrailing.html" + location.search + location.hash);</script>
</body>
</html>

104
bincode/config/trait.Options.html Normal file
View file

File diff suppressed because one or more lines are too long

2
bincode/de/index.html Normal file
View file

@ -0,0 +1,2 @@
<!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="Deserialize bincode data to a Rust data structure."><title>bincode::de - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module de</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bincode</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">bincode</a></span><h1>Module <span>de</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bincode/de/mod.rs.html#1-515">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserialize bincode data to a Rust data structure.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="read/index.html" title="mod bincode::de::read">read</a></div><div class="desc docblock-short">Specialized ways to read data into bincode.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Deserializer.html" title="struct bincode::de::Deserializer">Deserializer</a></div><div class="desc docblock-short">A Deserializer that reads bytes from a buffer.</div></li></ul></section></div></main></body></html>

2
bincode/de/read/index.html Normal file
View file

@ -0,0 +1,2 @@
<!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="Specialized ways to read data into bincode."><title>bincode::de::read - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module read</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In bincode::<wbr>de</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../../index.html">bincode</a>::<wbr><a href="../index.html">de</a></span><h1>Module <span>read</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/bincode/de/read.rs.html#1-202">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Specialized ways to read data into bincode.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.IoReader.html" title="struct bincode::de::read::IoReader">IoReader</a></div><div class="desc docblock-short">A BincodeRead implementation for <code>io::Read</code>ers</div></li><li><div class="item-name"><a class="struct" href="struct.SliceReader.html" title="struct bincode::de::read::SliceReader">Slice<wbr>Reader</a></div><div class="desc docblock-short">A BincodeRead implementation for byte slices</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.BincodeRead.html" title="trait bincode::de::read::BincodeRead">Bincode<wbr>Read</a></div><div class="desc docblock-short">An optional Read trait for advanced Bincode usage.</div></li></ul></section></div></main></body></html>

1
bincode/de/read/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["IoReader","SliceReader"],"trait":["BincodeRead"]};

33
bincode/de/read/struct.IoReader.html Normal file
View file

File diff suppressed because one or more lines are too long

26
bincode/de/read/struct.SliceReader.html Normal file
View file

File diff suppressed because one or more lines are too long

33
bincode/de/read/trait.BincodeRead.html Normal file
View file

@ -0,0 +1,33 @@
<!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="An optional Read trait for advanced Bincode usage."><title>BincodeRead in bincode::de::read - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Bincode<wbr>Read</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.forward_read_bytes" title="forward_read_bytes">forward_read_bytes</a></li><li><a href="#tymethod.forward_read_str" title="forward_read_str">forward_read_str</a></li><li><a href="#tymethod.get_byte_buffer" title="get_byte_buffer">get_byte_buffer</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In bincode::<wbr>de::<wbr>read</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../../index.html">bincode</a>::<wbr><a href="../index.html">de</a>::<wbr><a href="index.html">read</a></span><h1>Trait <span class="trait">BincodeRead</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/bincode/de/read.rs.html#13-27">Source</a> </span></div><pre class="rust item-decl"><code>pub trait BincodeRead&lt;'storage&gt;: <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Read.html" title="trait std::io::Read">Read</a> {
// Required methods
fn <a href="#tymethod.forward_read_str" class="fn">forward_read_str</a>&lt;V&gt;(
&amp;mut self,
length: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>,
visitor: V,
) -&gt; <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a>&lt;V::<a class="associatedtype" href="../../../serde/de/trait.Visitor.html#associatedtype.Value" title="type serde::de::Visitor::Value">Value</a>&gt;
<span class="where">where V: <a class="trait" href="../../../serde/de/trait.Visitor.html" title="trait serde::de::Visitor">Visitor</a>&lt;'storage&gt;</span>;
<span class="item-spacer"></span> fn <a href="#tymethod.get_byte_buffer" class="fn">get_byte_buffer</a>(&amp;mut self, length: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>) -&gt; <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>&gt;&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.forward_read_bytes" class="fn">forward_read_bytes</a>&lt;V&gt;(
&amp;mut self,
length: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>,
visitor: V,
) -&gt; <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a>&lt;V::<a class="associatedtype" href="../../../serde/de/trait.Visitor.html#associatedtype.Value" title="type serde::de::Visitor::Value">Value</a>&gt;
<span class="where">where V: <a class="trait" href="../../../serde/de/trait.Visitor.html" title="trait serde::de::Visitor">Visitor</a>&lt;'storage&gt;</span>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An optional Read trait for advanced Bincode usage.</p>
<p>It is highly recommended to use bincode with <code>io::Read</code> or <code>&amp;[u8]</code> before
implementing a custom <code>BincodeRead</code>.</p>
<p>The forward_read_* methods are necessary because some byte sources want
to pass a long-lived borrow to the visitor and others want to pass a
transient slice.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.forward_read_str" class="method"><a class="src rightside" href="../../../src/bincode/de/read.rs.html#16-18">Source</a><h4 class="code-header">fn <a href="#tymethod.forward_read_str" class="fn">forward_read_str</a>&lt;V&gt;(&amp;mut self, length: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>, visitor: V) -&gt; <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a>&lt;V::<a class="associatedtype" href="../../../serde/de/trait.Visitor.html#associatedtype.Value" title="type serde::de::Visitor::Value">Value</a>&gt;<div class="where">where
V: <a class="trait" href="../../../serde/de/trait.Visitor.html" title="trait serde::de::Visitor">Visitor</a>&lt;'storage&gt;,</div></h4></section></summary><div class="docblock"><p>Check that the next <code>length</code> bytes are a valid string and pass
it on to the serde reader.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.get_byte_buffer" class="method"><a class="src rightside" href="../../../src/bincode/de/read.rs.html#21">Source</a><h4 class="code-header">fn <a href="#tymethod.get_byte_buffer" class="fn">get_byte_buffer</a>(&amp;mut self, length: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>) -&gt; <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Transfer ownership of the next <code>length</code> bytes to the caller.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.forward_read_bytes" class="method"><a class="src rightside" href="../../../src/bincode/de/read.rs.html#24-26">Source</a><h4 class="code-header">fn <a href="#tymethod.forward_read_bytes" class="fn">forward_read_bytes</a>&lt;V&gt;(
&amp;mut self,
length: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>,
visitor: V,
) -&gt; <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a>&lt;V::<a class="associatedtype" href="../../../serde/de/trait.Visitor.html#associatedtype.Value" title="type serde::de::Visitor::Value">Value</a>&gt;<div class="where">where
V: <a class="trait" href="../../../serde/de/trait.Visitor.html" title="trait serde::de::Visitor">Visitor</a>&lt;'storage&gt;,</div></h4></section></summary><div class="docblock"><p>Pass a slice of the next <code>length</code> bytes on to the serde reader.</p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.1/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-BincodeRead%3C'a%3E-for-IoReader%3CR%3E" class="impl"><a class="src rightside" href="../../../src/bincode/de/read.rs.html#152-182">Source</a><a href="#impl-BincodeRead%3C'a%3E-for-IoReader%3CR%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, R&gt; <a class="trait" href="trait.BincodeRead.html" title="trait bincode::de::read::BincodeRead">BincodeRead</a>&lt;'a&gt; for <a class="struct" href="struct.IoReader.html" title="struct bincode::de::read::IoReader">IoReader</a>&lt;R&gt;<div class="where">where
R: <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Read.html" title="trait std::io::Read">Read</a>,</div></h3></section><section id="impl-BincodeRead%3C'storage%3E-for-SliceReader%3C'storage%3E" class="impl"><a class="src rightside" href="../../../src/bincode/de/read.rs.html#111-137">Source</a><a href="#impl-BincodeRead%3C'storage%3E-for-SliceReader%3C'storage%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'storage&gt; <a class="trait" href="trait.BincodeRead.html" title="trait bincode::de::read::BincodeRead">BincodeRead</a>&lt;'storage&gt; for <a class="struct" href="struct.SliceReader.html" title="struct bincode::de::read::SliceReader">SliceReader</a>&lt;'storage&gt;</h3></section></div><script src="../../../trait.impl/bincode/de/read/trait.BincodeRead.js" async></script></section></div></main></body></html>

1
bincode/de/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"mod":["read"],"struct":["Deserializer"]};

127
bincode/de/struct.Deserializer.html Normal file
View file

File diff suppressed because one or more lines are too long

37
bincode/enum.ErrorKind.html Normal file
View file

File diff suppressed because one or more lines are too long

11
bincode/error/enum.ErrorKind.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bincode/enum.ErrorKind.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bincode/enum.ErrorKind.html">../../bincode/enum.ErrorKind.html</a>...</p>
<script>location.replace("../../bincode/enum.ErrorKind.html" + location.search + location.hash);</script>
</body>
</html>

11
bincode/error/type.Error.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bincode/type.Error.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bincode/type.Error.html">../../bincode/type.Error.html</a>...</p>
<script>location.replace("../../bincode/type.Error.html" + location.search + location.hash);</script>
</body>
</html>

11
bincode/error/type.Result.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bincode/type.Result.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bincode/type.Result.html">../../bincode/type.Result.html</a>...</p>
<script>location.replace("../../bincode/type.Result.html" + location.search + location.hash);</script>
</body>
</html>

5
bincode/fn.config.html Normal file
View file

@ -0,0 +1,5 @@
<!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="Get a default configuration object."><title>config in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">config</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#default-configuration" title="Default Configuration:">Default Configuration:</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bincode</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Function <span class="fn">config</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/lib.rs.html#59-61">Source</a> </span></div><pre class="rust item-decl"><code>pub fn config() -&gt; <a class="struct" href="config/struct.Config.html" title="struct bincode::config::Config">Config</a></code></pre><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 1.3.0: please use <code>options()</code> instead</span></div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Get a default configuration object.</p>
<h4 id="default-configuration"><a class="doc-anchor" href="#default-configuration">§</a>Default Configuration:</h4><div><table><thead><tr><th>Byte limit</th><th>Endianness</th></tr></thead><tbody>
<tr><td>Unlimited</td><td>Little</td></tr>
</tbody></table>
</div></div></details></section></div></main></body></html>

7
bincode/fn.deserialize.html Normal file
View file

@ -0,0 +1,7 @@
<!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="Deserializes a slice of bytes into an instance of `T` using the default configuration."><title>deserialize in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Function <span class="fn">deserialize</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/lib.rs.html#177-185">Source</a> </span></div><pre class="rust item-decl"><code>pub fn deserialize&lt;'a, T&gt;(bytes: &amp;'a [<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>]) -&gt; <a class="type" href="type.Result.html" title="type bincode::Result">Result</a>&lt;T&gt;<div class="where">where
T: <a class="trait" href="../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a>&lt;'a&gt;,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserializes a slice of bytes into an instance of <code>T</code> using the default configuration.</p>
<p><strong>Warning:</strong> the default configuration used by this function is not
the same as that used by the <code>DefaultOptions</code> struct. See the
<a href="config/index.html#options-struct-vs-bincode-functions">config</a>
module for more details</p>
</div></details></section></div></main></body></html>

9
bincode/fn.deserialize_from.html Normal file
View file

@ -0,0 +1,9 @@
<!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="Deserializes an object directly from a `Read`er using the default configuration."><title>deserialize_from in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Function <span class="fn">deserialize_from</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/lib.rs.html#124-133">Source</a> </span></div><pre class="rust item-decl"><code>pub fn deserialize_from&lt;R, T&gt;(reader: R) -&gt; <a class="type" href="type.Result.html" title="type bincode::Result">Result</a>&lt;T&gt;<div class="where">where
R: <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Read.html" title="trait std::io::Read">Read</a>,
T: <a class="trait" href="../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Deserializes an object directly from a <code>Read</code>er using the default configuration.</p>
<p>If this returns an <code>Error</code>, <code>reader</code> may be in an invalid state.</p>
<p><strong>Warning:</strong> the default configuration used by this function is not
the same as that used by the <code>DefaultOptions</code> struct. See the
<a href="config/index.html#options-struct-vs-bincode-functions">config</a>
module for more details</p>
</div></details></section></div></main></body></html>

11
bincode/fn.deserialize_from_custom.html Normal file
View file

@ -0,0 +1,11 @@
<!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="Deserializes an object from a custom `BincodeRead`er using the default configuration. It is highly recommended to use `deserialize_from` unless you need to implement `BincodeRead` for performance reasons."><title>deserialize_from_custom in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Function <span class="fn">deserialize_from_custom</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/lib.rs.html#145-154">Source</a> </span></div><pre class="rust item-decl"><code>pub fn deserialize_from_custom&lt;'a, R, T&gt;(reader: R) -&gt; <a class="type" href="type.Result.html" title="type bincode::Result">Result</a>&lt;T&gt;<div class="where">where
R: <a class="trait" href="de/read/trait.BincodeRead.html" title="trait bincode::de::read::BincodeRead">BincodeRead</a>&lt;'a&gt;,
T: <a class="trait" href="../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><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>
<p>If this returns an <code>Error</code>, <code>reader</code> may be in an invalid state.</p>
<p><strong>Warning:</strong> the default configuration used by this function is not
the same as that used by the <code>DefaultOptions</code> struct. See the
<a href="config/index.html#options-struct-vs-bincode-functions">config</a>
module for more details</p>
</div></details></section></div></main></body></html>

10
bincode/fn.options.html Normal file
View file

@ -0,0 +1,10 @@
<!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="Get a default configuration object."><title>options in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">options</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#default-configuration" title="Default Configuration:">Default Configuration:</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bincode</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Function <span class="fn">options</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/lib.rs.html#77-79">Source</a> </span></div><pre class="rust item-decl"><code>pub fn options() -&gt; <a class="struct" href="config/struct.DefaultOptions.html" title="struct bincode::config::DefaultOptions">DefaultOptions</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Get a default configuration object.</p>
<p><strong>Warning:</strong> the default configuration returned by this function
is not the same as that used by the other functions in this
module. See the
<a href="config/index.html#options-struct-vs-bincode-functions">config</a>
module for more details</p>
<h4 id="default-configuration"><a class="doc-anchor" href="#default-configuration">§</a>Default Configuration:</h4><div><table><thead><tr><th>Byte limit</th><th>Endianness</th><th>Int Encoding</th><th>Trailing Behavior</th></tr></thead><tbody>
<tr><td>Unlimited</td><td>Little</td><td>Varint</td><td>Reject</td></tr>
</tbody></table>
</div></div></details></section></div></main></body></html>

7
bincode/fn.serialize.html Normal file
View file

@ -0,0 +1,7 @@
<!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="Serializes a serializable object into a `Vec` of bytes using the default configuration."><title>serialize in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Function <span class="fn">serialize</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/lib.rs.html#106-114">Source</a> </span></div><pre class="rust item-decl"><code>pub fn serialize&lt;T&gt;(value: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.reference.html">&amp;T</a>) -&gt; <a class="type" href="type.Result.html" title="type bincode::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>&gt;&gt;<div class="where">where
T: <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serializes a serializable object into a <code>Vec</code> of bytes using the default configuration.</p>
<p><strong>Warning:</strong> the default configuration used by this function is not
the same as that used by the <code>DefaultOptions</code> struct. See the
<a href="config/index.html#options-struct-vs-bincode-functions">config</a>
module for more details</p>
</div></details></section></div></main></body></html>

10
bincode/fn.serialize_into.html Normal file
View file

@ -0,0 +1,10 @@
<!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="Serializes an object directly into a `Writer` using the default configuration."><title>serialize_into in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Function <span class="fn">serialize_into</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/lib.rs.html#90-98">Source</a> </span></div><pre class="rust item-decl"><code>pub fn serialize_into&lt;W, T&gt;(writer: W, value: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.reference.html">&amp;T</a>) -&gt; <a class="type" href="type.Result.html" title="type bincode::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>&gt;<div class="where">where
W: <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write">Write</a>,
T: <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serializes an object directly into a <code>Writer</code> using the default configuration.</p>
<p>If the serialization would take more bytes than allowed by the size limit, an error
is returned and <em>no bytes</em> will be written into the <code>Writer</code>.</p>
<p><strong>Warning:</strong> the default configuration used by this function is not
the same as that used by the <code>DefaultOptions</code> struct. See the
<a href="config/index.html#options-struct-vs-bincode-functions">config</a>
module for more details</p>
</div></details></section></div></main></body></html>

7
bincode/fn.serialized_size.html Normal file
View file

@ -0,0 +1,7 @@
<!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="Returns the size that an object would be if serialized using Bincode with the default configuration."><title>serialized_size in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Function <span class="fn">serialized_size</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/lib.rs.html#193-201">Source</a> </span></div><pre class="rust item-decl"><code>pub fn serialized_size&lt;T&gt;(value: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.reference.html">&amp;T</a>) -&gt; <a class="type" href="type.Result.html" title="type bincode::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>&gt;<div class="where">where
T: <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returns the size that an object would be if serialized using Bincode with the default configuration.</p>
<p><strong>Warning:</strong> the default configuration used by this function is not
the same as that used by the <code>DefaultOptions</code> struct. See the
<a href="config/index.html#options-struct-vs-bincode-functions">config</a>
module for more details</p>
</div></details></section></div></main></body></html>

21
bincode/index.html Normal file
View file

@ -0,0 +1,21 @@
<!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="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!"><title>bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#using-basic-functions" title="Using Basic Functions">Using Basic Functions</a></li><li><a href="#128bit-numbers" title="128bit numbers">128bit numbers</a></li></ul><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>bincode</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/lib.rs.html#1-201">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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>
<h4 id="using-basic-functions"><a class="doc-anchor" href="#using-basic-functions">§</a>Using Basic Functions</h4>
<div class="example-wrap edition"><a href="#" class="tooltip" title="This example runs with edition 2018">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>main() {
<span class="comment">// The object that we will serialize.
</span><span class="kw">let </span>target: <span class="prelude-ty">Option</span>&lt;String&gt; = <span class="prelude-val">Some</span>(<span class="string">"hello world"</span>.to_string());
<span class="kw">let </span>encoded: Vec&lt;u8&gt; = bincode::serialize(<span class="kw-2">&amp;</span>target).unwrap();
<span class="kw">let </span>decoded: <span class="prelude-ty">Option</span>&lt;String&gt; = bincode::deserialize(<span class="kw-2">&amp;</span>encoded[..]).unwrap();
<span class="macro">assert_eq!</span>(target, decoded);
}</code></pre></div>
<h4 id="128bit-numbers"><a class="doc-anchor" href="#128bit-numbers">§</a>128bit numbers</h4>
<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> and disabled for targets which do not support it</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Config"><code>pub use config::<a class="struct" href="config/struct.Config.html" title="struct bincode::config::Config">Config</a>;</code></div><div class="desc docblock-short"><wbr><span class="stab deprecated" title="">Deprecated</span></div></li><li><div class="item-name" id="reexport.DefaultOptions"><code>pub use config::<a class="struct" href="config/struct.DefaultOptions.html" title="struct bincode::config::DefaultOptions">DefaultOptions</a>;</code></div></li><li><div class="item-name" id="reexport.Options"><code>pub use config::<a class="trait" href="config/trait.Options.html" title="trait bincode::config::Options">Options</a>;</code></div></li><li><div class="item-name" id="reexport.BincodeRead"><code>pub use de::read::<a class="trait" href="de/read/trait.BincodeRead.html" title="trait bincode::de::read::BincodeRead">BincodeRead</a>;</code></div></li><li><div class="item-name" id="reexport.Deserializer"><code>pub use de::<a class="struct" href="de/struct.Deserializer.html" title="struct bincode::de::Deserializer">Deserializer</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="config/index.html" title="mod bincode::config">config</a></div><div class="desc docblock-short"><code>bincode</code> uses a Builder-pattern to configure the Serializers and Deserializers in this
crate. This means that if you need to customize the behavior of <code>bincode</code>, you should create an
instance of the <code>DefaultOptions</code> struct:</div></li><li><div class="item-name"><a class="mod" href="de/index.html" title="mod bincode::de">de</a></div><div class="desc docblock-short">Deserialize bincode data to a Rust data structure.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Serializer.html" title="struct bincode::Serializer">Serializer</a></div><div class="desc docblock-short">An Serializer that encodes values directly into a Writer.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ErrorKind.html" title="enum bincode::ErrorKind">Error<wbr>Kind</a></div><div class="desc docblock-short">The kind of error that can be produced during a serialization or deserialization.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.config.html" title="fn bincode::config">config</a><wbr><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">Get a default configuration object.</div></li><li><div class="item-name"><a class="fn" href="fn.deserialize.html" title="fn bincode::deserialize">deserialize</a></div><div class="desc docblock-short">Deserializes a slice of bytes into an instance of <code>T</code> using the default configuration.</div></li><li><div class="item-name"><a class="fn" href="fn.deserialize_from.html" title="fn bincode::deserialize_from">deserialize_<wbr>from</a></div><div class="desc docblock-short">Deserializes an object directly from a <code>Read</code>er using the default configuration.</div></li><li><div class="item-name"><a class="fn" href="fn.deserialize_from_custom.html" title="fn bincode::deserialize_from_custom">deserialize_<wbr>from_<wbr>custom</a></div><div class="desc docblock-short">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.</div></li><li><div class="item-name"><a class="fn" href="fn.options.html" title="fn bincode::options">options</a></div><div class="desc docblock-short">Get a default configuration object.</div></li><li><div class="item-name"><a class="fn" href="fn.serialize.html" title="fn bincode::serialize">serialize</a></div><div class="desc docblock-short">Serializes a serializable object into a <code>Vec</code> of bytes using the default configuration.</div></li><li><div class="item-name"><a class="fn" href="fn.serialize_into.html" title="fn bincode::serialize_into">serialize_<wbr>into</a></div><div class="desc docblock-short">Serializes an object directly into a <code>Writer</code> using the default configuration.</div></li><li><div class="item-name"><a class="fn" href="fn.serialized_size.html" title="fn bincode::serialized_size">serialized_<wbr>size</a></div><div class="desc docblock-short">Returns the size that an object would be if serialized using Bincode with the default configuration.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Error.html" title="type bincode::Error">Error</a></div><div class="desc docblock-short">An error that can be produced during (de)serializing.</div></li><li><div class="item-name"><a class="type" href="type.Result.html" title="type bincode::Result">Result</a></div><div class="desc docblock-short">The result of a serialization or deserialization operation.</div></li></ul></section></div></main></body></html>

11
bincode/ser/struct.Serializer.html Normal file
View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../bincode/struct.Serializer.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../bincode/struct.Serializer.html">../../bincode/struct.Serializer.html</a>...</p>
<script>location.replace("../../bincode/struct.Serializer.html" + location.search + location.hash);</script>
</body>
</html>

1
bincode/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["ErrorKind"],"fn":["config","deserialize","deserialize_from","deserialize_from_custom","options","serialize","serialize_into","serialized_size"],"mod":["config","de"],"struct":["Serializer"],"type":["Error","Result"]};

98
bincode/struct.Serializer.html Normal file
View file

File diff suppressed because one or more lines are too long

11
bincode/type.Error.html Normal file
View file

@ -0,0 +1,11 @@
<!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="An error that can be produced during (de)serializing."><title>Error in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc type"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Error</a></h2><h3><a href="#aliased-type">Aliased type</a></h3><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Error-for-Box%3CErrorKind%3E" title="Error">Error</a></li><li><a href="#impl-Error-for-Box%3CErrorKind%3E-1" title="Error">Error</a></li><li><a href="#impl-From%3CError%3E-for-Box%3CErrorKind%3E" title="From&#60;Error&#62;">From&#60;Error&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bincode</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Type Alias <span class="type">Error</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/error.rs.html#12">Source</a> </span></div><pre class="rust item-decl"><code>pub type Error = <a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="enum" href="enum.ErrorKind.html" title="enum bincode::ErrorKind">ErrorKind</a>&gt;;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An error that can be produced during (de)serializing.</p>
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>struct Error(<span class="comment">/* private fields */</span>);</code></pre><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Error-for-Box%3CErrorKind%3E" class="impl"><a class="src rightside" href="../src/bincode/error.rs.html#105-109">Source</a><a href="#impl-Error-for-Box%3CErrorKind%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a> for <a class="type" href="type.Error.html" title="type bincode::Error">Error</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.custom" class="method trait-impl"><a class="src rightside" href="../src/bincode/error.rs.html#106-108">Source</a><a href="#method.custom" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/de/trait.Error.html#tymethod.custom" class="fn">custom</a>&lt;T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>&gt;(desc: T) -&gt; <a class="type" href="type.Error.html" title="type bincode::Error">Error</a></h4></section></summary><div class='docblock'>Raised when there is general error when deserializing a type. <a href="../serde/de/trait.Error.html#tymethod.custom">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.invalid_type" class="method trait-impl"><a class="src rightside" href="../src/serde/de/mod.rs.html#300">Source</a><a href="#method.invalid_type" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/de/trait.Error.html#method.invalid_type" class="fn">invalid_type</a>(unexp: <a class="enum" href="../serde/de/enum.Unexpected.html" title="enum serde::de::Unexpected">Unexpected</a>&lt;'_&gt;, exp: &amp;dyn <a class="trait" href="../serde/de/trait.Expected.html" title="trait serde::de::Expected">Expected</a>) -&gt; Self</h4></section></summary><div class='docblock'>Raised when a <code>Deserialize</code> receives a type different from what it was
expecting. <a href="../serde/de/trait.Error.html#method.invalid_type">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.invalid_value" class="method trait-impl"><a class="src rightside" href="../src/serde/de/mod.rs.html#300">Source</a><a href="#method.invalid_value" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/de/trait.Error.html#method.invalid_value" class="fn">invalid_value</a>(unexp: <a class="enum" href="../serde/de/enum.Unexpected.html" title="enum serde::de::Unexpected">Unexpected</a>&lt;'_&gt;, exp: &amp;dyn <a class="trait" href="../serde/de/trait.Expected.html" title="trait serde::de::Expected">Expected</a>) -&gt; Self</h4></section></summary><div class='docblock'>Raised when a <code>Deserialize</code> receives a value of the right type but that
is wrong for some other reason. <a href="../serde/de/trait.Error.html#method.invalid_value">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.invalid_length" class="method trait-impl"><a class="src rightside" href="../src/serde/de/mod.rs.html#300">Source</a><a href="#method.invalid_length" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/de/trait.Error.html#method.invalid_length" class="fn">invalid_length</a>(len: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>, exp: &amp;dyn <a class="trait" href="../serde/de/trait.Expected.html" title="trait serde::de::Expected">Expected</a>) -&gt; Self</h4></section></summary><div class='docblock'>Raised when deserializing a sequence or map and the input data contains
too many or too few elements. <a href="../serde/de/trait.Error.html#method.invalid_length">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.unknown_variant" class="method trait-impl"><a class="src rightside" href="../src/serde/de/mod.rs.html#300">Source</a><a href="#method.unknown_variant" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/de/trait.Error.html#method.unknown_variant" class="fn">unknown_variant</a>(variant: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.str.html">str</a>, expected: &amp;'static [&amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.str.html">str</a>]) -&gt; Self</h4></section></summary><div class='docblock'>Raised when a <code>Deserialize</code> enum type received a variant with an
unrecognized name.</div></details><details class="toggle method-toggle" open><summary><section id="method.unknown_field" class="method trait-impl"><a class="src rightside" href="../src/serde/de/mod.rs.html#300">Source</a><a href="#method.unknown_field" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/de/trait.Error.html#method.unknown_field" class="fn">unknown_field</a>(field: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.str.html">str</a>, expected: &amp;'static [&amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.str.html">str</a>]) -&gt; Self</h4></section></summary><div class='docblock'>Raised when a <code>Deserialize</code> struct type received a field with an
unrecognized name.</div></details><details class="toggle method-toggle" open><summary><section id="method.missing_field" class="method trait-impl"><a class="src rightside" href="../src/serde/de/mod.rs.html#300">Source</a><a href="#method.missing_field" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/de/trait.Error.html#method.missing_field" class="fn">missing_field</a>(field: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.str.html">str</a>) -&gt; Self</h4></section></summary><div class='docblock'>Raised when a <code>Deserialize</code> struct type expected to receive a required
field with a particular name but that field was not present in the
input.</div></details><details class="toggle method-toggle" open><summary><section id="method.duplicate_field" class="method trait-impl"><a class="src rightside" href="../src/serde/de/mod.rs.html#300">Source</a><a href="#method.duplicate_field" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/de/trait.Error.html#method.duplicate_field" class="fn">duplicate_field</a>(field: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.str.html">str</a>) -&gt; Self</h4></section></summary><div class='docblock'>Raised when a <code>Deserialize</code> struct type received more than one of the
same field.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Error-for-Box%3CErrorKind%3E-1" class="impl"><a class="src rightside" href="../src/bincode/error.rs.html#111-115">Source</a><a href="#impl-Error-for-Box%3CErrorKind%3E-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../serde/ser/trait.Error.html" title="trait serde::ser::Error">Error</a> for <a class="type" href="type.Error.html" title="type bincode::Error">Error</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.custom-1" class="method trait-impl"><a class="src rightside" href="../src/bincode/error.rs.html#112-114">Source</a><a href="#method.custom-1" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/ser/trait.Error.html#tymethod.custom" class="fn">custom</a>&lt;T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>&gt;(msg: T) -&gt; Self</h4></section></summary><div class='docblock'>Used when a <a href="../trait.Serialize.html"><code>Serialize</code></a> implementation encounters any error
while serializing a type. <a href="../serde/ser/trait.Error.html#tymethod.custom">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CError%3E-for-Box%3CErrorKind%3E" class="impl"><a class="src rightside" href="../src/bincode/error.rs.html#76-80">Source</a><a href="#impl-From%3CError%3E-for-Box%3CErrorKind%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt; for <a class="type" href="type.Error.html" title="type bincode::Error">Error</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/bincode/error.rs.html#77-79">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(err: <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>) -&gt; <a class="type" href="type.Error.html" title="type bincode::Error">Error</a></h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details></div><script src="../type.impl/alloc/boxed/struct.Box.js" data-self-path="bincode::error::Error" async></script></section></div></main></body></html>

7
bincode/type.Result.html Normal file
View file

@ -0,0 +1,7 @@
<!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="The result of a serialization or deserialization operation."><title>Result in bincode - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bincode" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc type"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bincode/index.html">bincode</a><span class="version">1.3.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Result</a></h2><h3><a href="#aliased-type">Aliased type</a></h3><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.Err" title="Err">Err</a></li><li><a href="#variant.Ok" title="Ok">Ok</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bincode</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bincode</a></span><h1>Type Alias <span class="type">Result</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bincode/error.rs.html#9">Source</a> </span></div><pre class="rust item-decl"><code>pub type Result&lt;T&gt; = <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, <a class="type" href="type.Error.html" title="type bincode::Error">Error</a>&gt;;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The result of a serialization or deserialization operation.</p>
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>enum Result&lt;T&gt; {
Ok(T),
Err(<a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="enum" href="enum.ErrorKind.html" title="enum bincode::ErrorKind">ErrorKind</a>&gt;),
}</code></pre><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.Ok" class="variant"><a href="#variant.Ok" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Ok(T)</h3></section><div class="docblock"><p>Contains the success value</p>
</div><section id="variant.Err" class="variant"><a href="#variant.Err" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Err(<a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="enum" href="enum.ErrorKind.html" title="enum bincode::ErrorKind">ErrorKind</a>&gt;)</h3></section><div class="docblock"><p>Contains the error value</p>
</div></div><script src="../type.impl/core/result/enum.Result.js" data-self-path="bincode::error::Result" async></script></section></div></main></body></html>