blob: eba14e6bc5d644656e94377c26761cdc20e32b14 [file] [log] [blame]
<!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="Configure length delimited `LengthDelimitedCodec`s."><meta name="keywords" content="rust, rustlang, rust-lang, Builder"><title>Builder in tokio_util::codec::length_delimited - 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" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="sidebar-items.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 struct"><!--[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">&#9776;</button><a class="sidebar-logo" href="../../../tokio_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../tokio_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Builder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.big_endian">big_endian</a></li><li><a href="#method.length_adjustment">length_adjustment</a></li><li><a href="#method.length_field_length">length_field_length</a></li><li><a href="#method.length_field_offset">length_field_offset</a></li><li><a href="#method.length_field_type">length_field_type</a></li><li><a href="#method.little_endian">little_endian</a></li><li><a href="#method.max_frame_length">max_frame_length</a></li><li><a href="#method.native_endian">native_endian</a></li><li><a href="#method.new">new</a></li><li><a href="#method.new_codec">new_codec</a></li><li><a href="#method.new_framed">new_framed</a></li><li><a href="#method.new_read">new_read</a></li><li><a href="#method.new_write">new_write</a></li><li><a href="#method.num_skip">num_skip</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Builder">Clone</a></li><li><a href="#impl-Copy-for-Builder">Copy</a></li><li><a href="#impl-Debug-for-Builder">Debug</a></li><li><a href="#impl-Default-for-Builder">Default</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Builder">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Builder">Send</a></li><li><a href="#impl-Sync-for-Builder">Sync</a></li><li><a href="#impl-Unpin-for-Builder">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Builder">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Builder">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Builder">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Builder">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-Builder">From&lt;T&gt;</a></li><li><a href="#impl-Instrument-for-Builder">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-Builder">Into&lt;U&gt;</a></li><li><a href="#impl-ToOwned-for-Builder">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Builder">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Builder">TryInto&lt;U&gt;</a></li><li><a href="#impl-WithSubscriber-for-Builder">WithSubscriber</a></li></ul></section><h2><a href="index.html">In tokio_util::codec::length_delimited</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../../index.html">tokio_util</a>::<wbr><a href="../index.html">codec</a>::<wbr><a href="index.html">length_delimited</a>::<wbr><a class="struct" href="#">Builder</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></h1><span class="out-of-band"><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#390-409">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Builder { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Configure length delimited <code>LengthDelimitedCodec</code>s.</p>
<p><code>Builder</code> enables constructing configured length delimited codecs. Note
that not all configuration settings apply to both encoding and decoding. See
the documentation for specific methods for more detail.</p>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#646-1021">source</a><a href="#impl-Builder" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#666-686">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -&gt; <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Creates a new length delimited codec builder with default configuration
values.</p>
<h5 id="examples"><a href="#examples">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.length_field_offset(<span class="number">0</span>)
.length_field_type::&lt;u16&gt;()
.length_adjustment(<span class="number">0</span>)
.num_skip(<span class="number">0</span>)
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.big_endian" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#707-710">source</a><h4 class="code-header">pub fn <a href="#method.big_endian" class="fnname">big_endian</a>(&amp;mut self) -&gt; &amp;mut Self</h4></section></summary><div class="docblock"><p>Read the length field as a big endian integer</p>
<p>This is the default setting.</p>
<p>This configuration option applies to both encoding and decoding.</p>
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.big_endian()
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.little_endian" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#731-734">source</a><h4 class="code-header">pub fn <a href="#method.little_endian" class="fnname">little_endian</a>(&amp;mut self) -&gt; &amp;mut Self</h4></section></summary><div class="docblock"><p>Read the length field as a little endian integer</p>
<p>The default setting is big endian.</p>
<p>This configuration option applies to both encoding and decoding.</p>
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.little_endian()
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.native_endian" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#755-761">source</a><h4 class="code-header">pub fn <a href="#method.native_endian" class="fnname">native_endian</a>(&amp;mut self) -&gt; &amp;mut Self</h4></section></summary><div class="docblock"><p>Read the length field as a native endian integer</p>
<p>The default setting is big endian.</p>
<p>This configuration option applies to both encoding and decoding.</p>
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.native_endian()
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max_frame_length" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#789-792">source</a><h4 class="code-header">pub fn <a href="#method.max_frame_length" class="fnname">max_frame_length</a>(&amp;mut self, val: usize) -&gt; &amp;mut Self</h4></section></summary><div class="docblock"><p>Sets the max frame length in bytes</p>
<p>This configuration option applies to both encoding and decoding. The
default value is 8MB.</p>
<p>When decoding, the length field read from the byte stream is checked
against this setting <strong>before</strong> any adjustments are applied. When
encoding, the length of the submitted payload is checked against this
setting.</p>
<p>When frames exceed the max length, an <code>io::Error</code> with the custom value
of the <code>LengthDelimitedCodecError</code> type will be returned.</p>
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.max_frame_length(<span class="number">8 </span>* <span class="number">1024 </span>* <span class="number">1024</span>)
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.length_field_type" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#826-828">source</a><h4 class="code-header">pub fn <a href="#method.length_field_type" class="fnname">length_field_type</a>&lt;T:&nbsp;LengthFieldType&gt;(&amp;mut self) -&gt; &amp;mut Self</h4></section></summary><div class="docblock"><p>Sets the unsigned integer type used to represent the length field.</p>
<p>The default type is [<code>u32</code>]. The max type is [<code>u64</code>] (or [<code>usize</code>] on
64-bit targets).</p>
<h5 id="examples-5"><a href="#examples-5">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.length_field_type::&lt;u32&gt;()
.new_read(io);</code></pre></div>
<p>Unlike <a href="struct.Builder.html#method.length_field_length" title="Builder::length_field_length"><code>Builder::length_field_length</code></a>, this does not fail at runtime
and instead produces a compile error:</p>
<div class="example-wrap compile_fail"><div class='tooltip'></div><pre class="rust rust-example-rendered"><code>LengthDelimitedCodec::builder()
.length_field_type::&lt;u128&gt;()
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.length_field_length" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#849-853">source</a><h4 class="code-header">pub fn <a href="#method.length_field_length" class="fnname">length_field_length</a>(&amp;mut self, val: usize) -&gt; &amp;mut Self</h4></section></summary><div class="docblock"><p>Sets the number of bytes used to represent the length field</p>
<p>The default value is <code>4</code>. The max value is <code>8</code>.</p>
<p>This configuration option applies to both encoding and decoding.</p>
<h5 id="examples-6"><a href="#examples-6">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.length_field_length(<span class="number">4</span>)
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.length_field_offset" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#872-875">source</a><h4 class="code-header">pub fn <a href="#method.length_field_offset" class="fnname">length_field_offset</a>(&amp;mut self, val: usize) -&gt; &amp;mut Self</h4></section></summary><div class="docblock"><p>Sets the number of bytes in the header before the length field</p>
<p>This configuration option only applies to decoding.</p>
<h5 id="examples-7"><a href="#examples-7">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.length_field_offset(<span class="number">1</span>)
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.length_adjustment" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#893-896">source</a><h4 class="code-header">pub fn <a href="#method.length_adjustment" class="fnname">length_adjustment</a>(&amp;mut self, val: isize) -&gt; &amp;mut Self</h4></section></summary><div class="docblock"><p>Delta between the payload length specified in the header and the real
payload length</p>
<h5 id="examples-8"><a href="#examples-8">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.length_adjustment(-<span class="number">2</span>)
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.num_skip" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#917-920">source</a><h4 class="code-header">pub fn <a href="#method.num_skip" class="fnname">num_skip</a>(&amp;mut self, val: usize) -&gt; &amp;mut Self</h4></section></summary><div class="docblock"><p>Sets the number of bytes to skip before reading the payload</p>
<p>Default value is <code>length_field_len + length_field_offset</code></p>
<p>This configuration option only applies to decoding</p>
<h5 id="examples-9"><a href="#examples-9">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.num_skip(<span class="number">4</span>)
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_codec" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#937-942">source</a><h4 class="code-header">pub fn <a href="#method.new_codec" class="fnname">new_codec</a>(&amp;self) -&gt; <a class="struct" href="struct.LengthDelimitedCodec.html" title="struct tokio_util::codec::length_delimited::LengthDelimitedCodec">LengthDelimitedCodec</a></h4></section></summary><div class="docblock"><p>Create a configured length delimited <code>LengthDelimitedCodec</code></p>
<h5 id="examples-10"><a href="#examples-10">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.length_field_offset(<span class="number">0</span>)
.length_field_type::&lt;u16&gt;()
.length_adjustment(<span class="number">0</span>)
.num_skip(<span class="number">0</span>)
.new_codec();</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_read" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#962-967">source</a><h4 class="code-header">pub fn <a href="#method.new_read" class="fnname">new_read</a>&lt;T&gt;(&amp;self, upstream: T) -&gt; <a class="struct" href="../struct.FramedRead.html" title="struct tokio_util::codec::FramedRead">FramedRead</a>&lt;T, <a class="struct" href="struct.LengthDelimitedCodec.html" title="struct tokio_util::codec::length_delimited::LengthDelimitedCodec">LengthDelimitedCodec</a>&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead">AsyncRead</a>,</span></h4></section></summary><div class="docblock"><p>Create a configured length delimited <code>FramedRead</code></p>
<h5 id="examples-11"><a href="#examples-11">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio_util::codec::LengthDelimitedCodec;
LengthDelimitedCodec::builder()
.length_field_offset(<span class="number">0</span>)
.length_field_type::&lt;u16&gt;()
.length_adjustment(<span class="number">0</span>)
.num_skip(<span class="number">0</span>)
.new_read(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_write" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#983-988">source</a><h4 class="code-header">pub fn <a href="#method.new_write" class="fnname">new_write</a>&lt;T&gt;(&amp;self, inner: T) -&gt; <a class="struct" href="../struct.FramedWrite.html" title="struct tokio_util::codec::FramedWrite">FramedWrite</a>&lt;T, <a class="struct" href="struct.LengthDelimitedCodec.html" title="struct tokio_util::codec::length_delimited::LengthDelimitedCodec">LengthDelimitedCodec</a>&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite">AsyncWrite</a>,</span></h4></section></summary><div class="docblock"><p>Create a configured length delimited <code>FramedWrite</code></p>
<h5 id="examples-12"><a href="#examples-12">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>LengthDelimitedCodec::builder()
.length_field_type::&lt;u16&gt;()
.new_write(io);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new_framed" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#1005-1010">source</a><h4 class="code-header">pub fn <a href="#method.new_framed" class="fnname">new_framed</a>&lt;T&gt;(&amp;self, inner: T) -&gt; <a class="struct" href="../struct.Framed.html" title="struct tokio_util::codec::Framed">Framed</a>&lt;T, <a class="struct" href="struct.LengthDelimitedCodec.html" title="struct tokio_util::codec::length_delimited::LengthDelimitedCodec">LengthDelimitedCodec</a>&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead">AsyncRead</a> + <a class="trait" href="../../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite">AsyncWrite</a>,</span></h4></section></summary><div class="docblock"><p>Create a configured length delimited <code>Framed</code></p>
<h5 id="examples-13"><a href="#examples-13">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>LengthDelimitedCodec::builder()
.length_field_type::&lt;u16&gt;()
.new_framed(io);</code></pre></div>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#389">source</a><a href="#impl-Clone-for-Builder" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#389">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#389">source</a><a href="#impl-Debug-for-Builder" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#389">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#1023-1027">source</a><a href="#impl-Default-for-Builder" class="anchor"></a><h3 class="code-header">impl Default for <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#1024-1026">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a class="fnname">default</a>() -&gt; Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details><section id="impl-Copy-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio_util/codec/length_delimited.rs.html#389">source</a><a href="#impl-Copy-for-Builder" class="anchor"></a><h3 class="code-header">impl Copy for <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Builder" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Builder" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section><section id="impl-Send-for-Builder" class="impl has-srclink"><a href="#impl-Send-for-Builder" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section><section id="impl-Sync-for-Builder" class="impl has-srclink"><a href="#impl-Sync-for-Builder" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section><section id="impl-Unpin-for-Builder" class="impl has-srclink"><a href="#impl-Unpin-for-Builder" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section><section id="impl-UnwindSafe-for-Builder" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Builder" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Builder" class="impl has-srclink"><a href="#impl-Any-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Builder" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Builder" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Builder" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Instrument-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#276">source</a><a href="#impl-Instrument-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#82">source</a><a href="#method.instrument" class="anchor"></a><h4 class="code-header">fn <a href="../../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -&gt; <a class="struct" href="../../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="../../../tracing/span/struct.Span.html" title="Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="../../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#121">source</a><a href="#method.in_current_span" class="anchor"></a><h4 class="code-header">fn <a href="../../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -&gt; <a class="struct" href="../../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the <a href="../../../tracing/span/struct.Span.html#method.current">current</a> <a href="../../../tracing/span/struct.Span.html"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="../../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Builder" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Builder" class="impl has-srclink"><a href="#impl-ToOwned-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; ToOwned for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&amp;self, target: &amp;mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Builder" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Builder" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-WithSubscriber-for-Builder" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#334">source</a><a href="#impl-WithSubscriber-for-Builder" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../../tracing/instrument/trait.WithSubscriber.html" title="trait tracing::instrument::WithSubscriber">WithSubscriber</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#169-171">source</a><a href="#method.with_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="../../../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber" class="fnname">with_subscriber</a>&lt;S&gt;(self, subscriber: S) -&gt; <a class="struct" href="../../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a>&lt;Self&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: Into&lt;<a class="struct" href="../../../tracing_core/dispatcher/struct.Dispatch.html" title="struct tracing_core::dispatcher::Dispatch">Dispatch</a>&gt;,</span></h4></section></summary><div class='docblock'>Attaches the provided <a href="../../../tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
<a href="../../../tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../../../tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tracing/instrument.rs.html#221">source</a><a href="#method.with_current_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="../../../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -&gt; <a class="struct" href="../../../tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Attaches the current <a href="../../../tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="../../../tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
<a href="../../../tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="../../../tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tokio_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>