18 lines
13 KiB
HTML
18 lines
13 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="An optional Read trait for advanced Bincode usage."><meta name="keywords" content="rust, rustlang, rust-lang, BincodeRead"><title>BincodeRead in bincode::de::read - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><script defer src="../../../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../../bincode/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait BincodeRead</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.forward_read_bytes">forward_read_bytes</a><a href="#tymethod.forward_read_str">forward_read_str</a><a href="#tymethod.get_byte_buffer">get_byte_buffer</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../../index.html">bincode</a>::<wbr><a href="../index.html">de</a>::<wbr><a href="index.html">read</a></h2><div id="sidebar-vars" data-name="BincodeRead" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../bincode/index.html"><img class="rust-logo" src="../../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../../index.html">bincode</a>::<wbr><a href="../index.html">de</a>::<wbr><a href="index.html">read</a>::<wbr><a class="trait" href="#">BincodeRead</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../../src/bincode/de/read.rs.html#13-27" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait BincodeRead<'storage>: <a class="trait" href="https://doc.rust-lang.org/1.59.0/std/io/trait.Read.html" title="trait std::io::Read">Read</a> {
|
||
fn <a href="#tymethod.forward_read_str" class="fnname">forward_read_str</a><V>(<br> &mut self, <br> length: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>, <br> visitor: V<br> ) -> <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a><V::<a class="associatedtype" href="../../../serde/de/trait.Visitor.html#associatedtype.Value" title="type serde::de::Visitor::Value">Value</a>><br> <span class="where">where<br> V: <a class="trait" href="../../../serde/de/trait.Visitor.html" title="trait serde::de::Visitor">Visitor</a><'storage></span>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.get_byte_buffer" class="fnname">get_byte_buffer</a>(&mut self, length: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>) -> <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.forward_read_bytes" class="fnname">forward_read_bytes</a><V>(<br> &mut self, <br> length: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>, <br> visitor: V<br> ) -> <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a><V::<a class="associatedtype" href="../../../serde/de/trait.Visitor.html#associatedtype.Value" title="type serde::de::Visitor::Value">Value</a>><br> <span class="where">where<br> V: <a class="trait" href="../../../serde/de/trait.Visitor.html" title="trait serde::de::Visitor">Visitor</a><'storage></span>;
|
||
}</code></pre></div><details class="rustdoc-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>&[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="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.forward_read_str" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bincode/de/read.rs.html#16-18" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.forward_read_str" class="fnname">forward_read_str</a><V>(&mut self, length: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>, visitor: V) -> <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a><V::<a class="associatedtype" href="../../../serde/de/trait.Visitor.html#associatedtype.Value" title="type serde::de::Visitor::Value">Value</a>> <span class="where fmt-newline">where<br> V: <a class="trait" href="../../../serde/de/trait.Visitor.html" title="trait serde::de::Visitor">Visitor</a><'storage>, </span></h4></div></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="rustdoc-toggle" open><summary><div id="tymethod.get_byte_buffer" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bincode/de/read.rs.html#21" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.get_byte_buffer" class="fnname">get_byte_buffer</a>(&mut self, length: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>) -> <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.59.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a>>></h4></div></summary><div class="docblock"><p>Transfer ownership of the next <code>length</code> bytes to the caller.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.forward_read_bytes" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bincode/de/read.rs.html#24-26" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.forward_read_bytes" class="fnname">forward_read_bytes</a><V>(<br> &mut self, <br> length: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>, <br> visitor: V<br>) -> <a class="type" href="../../type.Result.html" title="type bincode::Result">Result</a><V::<a class="associatedtype" href="../../../serde/de/trait.Visitor.html#associatedtype.Value" title="type serde::de::Visitor::Value">Value</a>> <span class="where fmt-newline">where<br> V: <a class="trait" href="../../../serde/de/trait.Visitor.html" title="trait serde::de::Visitor">Visitor</a><'storage>, </span></h4></div></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="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><div id="impl-BincodeRead%3C%27a%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bincode/de/read.rs.html#152-182" title="goto source code">[src]</a></div><a href="#impl-BincodeRead%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a, R> <a class="trait" href="trait.BincodeRead.html" title="trait bincode::de::read::BincodeRead">BincodeRead</a><'a> for <a class="struct" href="struct.IoReader.html" title="struct bincode::de::read::IoReader">IoReader</a><R> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.59.0/std/io/trait.Read.html" title="trait std::io::Read">Read</a>, </span></h3></div><div id="impl-BincodeRead%3C%27storage%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/bincode/de/read.rs.html#111-137" title="goto source code">[src]</a></div><a href="#impl-BincodeRead%3C%27storage%3E" class="anchor"></a><h3 class="code-header in-band">impl<'storage> <a class="trait" href="trait.BincodeRead.html" title="trait bincode::de::read::BincodeRead">BincodeRead</a><'storage> for <a class="struct" href="struct.SliceReader.html" title="struct bincode::de::read::SliceReader">SliceReader</a><'storage></h3></div></div><script type="text/javascript" src="../../../implementors/bincode/de/read/trait.BincodeRead.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="bincode" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |