github-actions[bot]
155 lines
43 KiB
HTML
155 lines
43 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Builder` struct in crate `tokio_util`."><meta name="keywords" content="rust, rustlang, rust-lang, Builder"><title>tokio_util::codec::length_delimited::Builder - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../tokio_util/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><p class="location">Struct Builder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.big_endian">big_endian</a><a href="#method.length_adjustment">length_adjustment</a><a href="#method.length_field_length">length_field_length</a><a href="#method.length_field_offset">length_field_offset</a><a href="#method.little_endian">little_endian</a><a href="#method.max_frame_length">max_frame_length</a><a href="#method.native_endian">native_endian</a><a href="#method.new">new</a><a href="#method.new_codec">new_codec</a><a href="#method.new_framed">new_framed</a><a href="#method.new_read">new_read</a><a href="#method.new_write">new_write</a><a href="#method.num_skip">num_skip</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../../index.html">tokio_util</a>::<wbr><a href="../index.html">codec</a>::<wbr><a href="index.html">length_delimited</a></p><div id="sidebar-vars" data-name="Builder" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">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></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/tokio_util/codec/length_delimited.rs.html#390-409" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct Builder { /* fields omitted */ }</pre></div><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><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#632-971" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>() -> <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#652-672" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new length delimited codec builder with default configuration
|
||
values.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">length_field_offset</span>(<span class="number">0</span>)
|
||
.<span class="ident">length_field_length</span>(<span class="number">2</span>)
|
||
.<span class="ident">length_adjustment</span>(<span class="number">0</span>)
|
||
.<span class="ident">num_skip</span>(<span class="number">0</span>)
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.big_endian" class="method"><code>pub fn <a href="#method.big_endian" class="fnname">big_endian</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#693-696" title="goto source code">[src]</a></h4><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>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">big_endian</span>()
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.little_endian" class="method"><code>pub fn <a href="#method.little_endian" class="fnname">little_endian</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#717-720" title="goto source code">[src]</a></h4><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>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">little_endian</span>()
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.native_endian" class="method"><code>pub fn <a href="#method.native_endian" class="fnname">native_endian</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#741-747" title="goto source code">[src]</a></h4><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>
|
||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">native_endian</span>()
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.max_frame_length" class="method"><code>pub fn <a href="#method.max_frame_length" class="fnname">max_frame_length</a>(&mut self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#775-778" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the max frame length</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>
|
||
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">max_frame_length</span>(<span class="number">8</span> <span class="op">*</span> <span class="number">1024</span>)
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.length_field_length" class="method"><code>pub fn <a href="#method.length_field_length" class="fnname">length_field_length</a>(&mut self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#799-803" title="goto source code">[src]</a></h4><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>
|
||
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">length_field_length</span>(<span class="number">4</span>)
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.length_field_offset" class="method"><code>pub fn <a href="#method.length_field_offset" class="fnname">length_field_offset</a>(&mut self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#822-825" title="goto source code">[src]</a></h4><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>
|
||
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">length_field_offset</span>(<span class="number">1</span>)
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.length_adjustment" class="method"><code>pub fn <a href="#method.length_adjustment" class="fnname">length_adjustment</a>(&mut self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#843-846" title="goto source code">[src]</a></h4><div class="docblock"><p>Delta between the payload length specified in the header and the real
|
||
payload length</p>
|
||
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">length_adjustment</span>(<span class="op">-</span><span class="number">2</span>)
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.num_skip" class="method"><code>pub fn <a href="#method.num_skip" class="fnname">num_skip</a>(&mut self, val: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#867-870" title="goto source code">[src]</a></h4><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>
|
||
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">num_skip</span>(<span class="number">4</span>)
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.new_codec" class="method"><code>pub fn <a href="#method.new_codec" class="fnname">new_codec</a>(&self) -> <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.LengthDelimitedCodec.html" title="struct tokio_util::codec::length_delimited::LengthDelimitedCodec">LengthDelimitedCodec</a></code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#887-892" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a configured length delimited <code>LengthDelimitedCodec</code></p>
|
||
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">length_field_offset</span>(<span class="number">0</span>)
|
||
.<span class="ident">length_field_length</span>(<span class="number">2</span>)
|
||
.<span class="ident">length_adjustment</span>(<span class="number">0</span>)
|
||
.<span class="ident">num_skip</span>(<span class="number">0</span>)
|
||
.<span class="ident">new_codec</span>();</pre></div>
|
||
</div><h4 id="method.new_read" class="method"><code>pub fn <a href="#method.new_read" class="fnname">new_read</a><T>(&self, upstream: T) -> <a class="struct" href="../../../tokio_util/codec/struct.FramedRead.html" title="struct tokio_util::codec::FramedRead">FramedRead</a><T, <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.LengthDelimitedCodec.html" title="struct tokio_util::codec::length_delimited::LengthDelimitedCodec">LengthDelimitedCodec</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../../tokio/io/async_read/trait.AsyncRead.html" title="trait tokio::io::async_read::AsyncRead">AsyncRead</a>, </span></code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#912-917" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a configured length delimited <code>FramedRead</code></p>
|
||
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio_util</span>::<span class="ident">codec</span>::<span class="ident">LengthDelimitedCodec</span>;
|
||
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">length_field_offset</span>(<span class="number">0</span>)
|
||
.<span class="ident">length_field_length</span>(<span class="number">2</span>)
|
||
.<span class="ident">length_adjustment</span>(<span class="number">0</span>)
|
||
.<span class="ident">num_skip</span>(<span class="number">0</span>)
|
||
.<span class="ident">new_read</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.new_write" class="method"><code>pub fn <a href="#method.new_write" class="fnname">new_write</a><T>(&self, inner: T) -> <a class="struct" href="../../../tokio_util/codec/struct.FramedWrite.html" title="struct tokio_util::codec::FramedWrite">FramedWrite</a><T, <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.LengthDelimitedCodec.html" title="struct tokio_util::codec::length_delimited::LengthDelimitedCodec">LengthDelimitedCodec</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../../tokio/io/async_write/trait.AsyncWrite.html" title="trait tokio::io::async_write::AsyncWrite">AsyncWrite</a>, </span></code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#933-938" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a configured length delimited <code>FramedWrite</code></p>
|
||
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">length_field_length</span>(<span class="number">2</span>)
|
||
.<span class="ident">new_write</span>(<span class="ident">io</span>);</pre></div>
|
||
</div><h4 id="method.new_framed" class="method"><code>pub fn <a href="#method.new_framed" class="fnname">new_framed</a><T>(&self, inner: T) -> <a class="struct" href="../../../tokio_util/codec/struct.Framed.html" title="struct tokio_util::codec::Framed">Framed</a><T, <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.LengthDelimitedCodec.html" title="struct tokio_util::codec::length_delimited::LengthDelimitedCodec">LengthDelimitedCodec</a>> <span class="where fmt-newline">where<br> 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></code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#955-960" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a configured length delimited <code>Framed</code></p>
|
||
<h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="ident">LengthDelimitedCodec</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">length_field_length</span>(<span class="number">2</span>)
|
||
.<span class="ident">new_framed</span>(<span class="ident">io</span>);</pre></div>
|
||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#389" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#389" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id="method.clone_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#128" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id="impl-Copy" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl-Copy" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#389" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#389" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#389" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id="impl-Default" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#973-977" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</code><a class="srclink" href="../../../src/tokio_util/codec/length_delimited.rs.html#974-976" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div></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"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl-Unpin" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../../tokio_util/codec/length_delimited/struct.Builder.html" title="struct tokio_util::codec::length_delimited::Builder">Builder</a></code><a href="#impl-UnwindSafe" class="anchor"></a><a class="srclink" href="../../../src/tokio_util/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-ToOwned" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href="#impl-ToOwned" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#80-92" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Owned" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div><h4 id="method.to_owned" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div><h4 id="method.clone_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><details><summary><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tokio_util"></div>
|
||
<script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |