Auto Generated Documentation

This commit is contained in:
github-actions[bot]
2021-03-22 03:10:14 +00:00
parent 7334bd1757
commit 8193a198a1
741 changed files with 3292 additions and 70875 deletions
+5 -2
View File
@@ -19,8 +19,11 @@ applications.</p>
</div><h4 id="method.poll_trailers" class="method hidden"><code>fn <a href="../hyper/body/trait.HttpBody.html#tymethod.poll_trailers" class="fnname">poll_trailers</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;cx: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a>&lt;'_&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../hyper/struct.HeaderMap.html" title="struct hyper::HeaderMap">HeaderMap</a>&gt;, Self::<a class="type" href="../hyper/body/trait.HttpBody.html#associatedtype.Error" title="type hyper::body::HttpBody::Error">Error</a>&gt;&gt;</code><a class="srclink" href="../src/hyper/body/body.rs.html#362-390" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Poll for an optional <strong>single</strong> <code>HeaderMap</code> of trailers. <a href="../hyper/body/trait.HttpBody.html#tymethod.poll_trailers">Read more</a></p>
</div><h4 id="method.is_end_stream" class="method hidden"><code>fn <a href="../hyper/body/trait.HttpBody.html#method.is_end_stream" class="fnname">is_end_stream</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../src/hyper/body/body.rs.html#392-403" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns <code>true</code> when the end of stream has been reached. <a href="../hyper/body/trait.HttpBody.html#method.is_end_stream">Read more</a></p>
</div><h4 id="method.size_hint" class="method hidden"><code>fn <a href="../hyper/body/trait.HttpBody.html#method.size_hint" class="fnname">size_hint</a>(&amp;self) -&gt; <a class="struct" href="../hyper/body/struct.SizeHint.html" title="struct hyper::body::SizeHint">SizeHint</a></code><a class="srclink" href="../src/hyper/body/body.rs.html#405-429" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns the bounds on the remaining length of the stream. <a href="../hyper/body/trait.HttpBody.html#method.size_hint">Read more</a></p>
</div><h4 id="method.data" class="method hidden"><code>pub fn <a href="../hyper/body/trait.HttpBody.html#method.data" class="fnname">data</a>(&amp;mut self) -&gt; <a class="struct" href="../http_body/next/struct.Data.html" title="struct http_body::next::Data">Data</a>&lt;'_, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,&nbsp;</span></code><a class="srclink" href="../src/http_body/lib.rs.html#72-77" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns future that resolves to next data chunk, if any.</p>
</div><h4 id="method.trailers" class="method hidden"><code>pub fn <a href="../hyper/body/trait.HttpBody.html#method.trailers" class="fnname">trailers</a>(&amp;mut self) -&gt; <a class="struct" href="../http_body/next/struct.Trailers.html" title="struct http_body::next::Trailers">Trailers</a>&lt;'_, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,&nbsp;</span></code><a class="srclink" href="../src/http_body/lib.rs.html#80-85" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns future that resolves to trailers, if any.</p>
</div><h4 id="method.data" class="method hidden"><code>pub fn <a href="../hyper/body/trait.HttpBody.html#method.data" class="fnname">data</a>(&amp;mut self) -&gt; <a class="struct" href="../http_body/next/struct.Data.html" title="struct http_body::next::Data">Data</a>&lt;'_, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,&nbsp;</span></code><a class="srclink" href="../src/http_body/lib.rs.html#82-87" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns future that resolves to next data chunk, if any.</p>
</div><h4 id="method.trailers" class="method hidden"><code>pub fn <a href="../hyper/body/trait.HttpBody.html#method.trailers" class="fnname">trailers</a>(&amp;mut self) -&gt; <a class="struct" href="../http_body/next/struct.Trailers.html" title="struct http_body::next::Trailers">Trailers</a>&lt;'_, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,&nbsp;</span></code><a class="srclink" href="../src/http_body/lib.rs.html#90-95" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns future that resolves to trailers, if any.</p>
</div><h4 id="method.map_data" class="method hidden"><code>pub fn <a href="../hyper/body/trait.HttpBody.html#method.map_data" class="fnname">map_data</a>&lt;F, B&gt;(self, f: F) -&gt; <a class="struct" href="../http_body/combinators/map_data/struct.MapData.html" title="struct http_body::combinators::map_data::MapData">MapData</a>&lt;Self, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../hyper/body/trait.HttpBody.html#associatedtype.Data" title="type hyper::body::HttpBody::Data">Data</a>) -&gt; B,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../hyper/body/trait.Buf.html" title="trait hyper::body::Buf">Buf</a>,&nbsp;</span></code><a class="srclink" href="../src/http_body/lib.rs.html#98-105" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this body's data value to a different value.</p>
</div><h4 id="method.map_err" class="method hidden"><code>pub fn <a href="../hyper/body/trait.HttpBody.html#method.map_err" class="fnname">map_err</a>&lt;F, E&gt;(self, f: F) -&gt; <a class="struct" href="../http_body/combinators/map_err/struct.MapErr.html" title="struct http_body::combinators::map_err::MapErr">MapErr</a>&lt;Self, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../hyper/body/trait.HttpBody.html#associatedtype.Error" title="type hyper::body::HttpBody::Error">Error</a>) -&gt; E,&nbsp;</span></code><a class="srclink" href="../src/http_body/lib.rs.html#108-114" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Maps this body's error value to a different value.</p>
</div><h4 id="method.boxed" class="method hidden"><code>pub fn <a href="../hyper/body/trait.HttpBody.html#method.boxed" class="fnname">boxed</a>(self) -&gt; <a class="struct" href="../http_body/combinators/box_body/struct.BoxBody.html" title="struct http_body::combinators::box_body::BoxBody">BoxBody</a>&lt;Self::<a class="type" href="../hyper/body/trait.HttpBody.html#associatedtype.Data" title="type hyper::body::HttpBody::Data">Data</a>, Self::<a class="type" href="../hyper/body/trait.HttpBody.html#associatedtype.Error" title="type hyper::body::HttpBody::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static,&nbsp;</span></code><a class="srclink" href="../src/http_body/lib.rs.html#117-122" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Turn this body into a boxed trait object.</p>
</div></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="../hyper/body/struct.Body.html" title="struct hyper::body::Body">Body</a></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../src/hyper/body/body.rs.html#432-450" 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>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <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/hyper/body/body.rs.html#433-449" 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="../hyper/body/struct.Body.html" title="struct hyper::body::Body">Body</a></code><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../src/hyper/body/body.rs.html#343-349" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -&gt; <a class="struct" href="../hyper/body/struct.Body.html" title="struct hyper::body::Body">Body</a></code><a class="srclink" href="../src/hyper/body/body.rs.html#346-348" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns <code>Body::empty()</code>.</p>
</div></div><h3 id="impl-From%3C%26%27static%20%5Bu8%5D%3E" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'static [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>&gt; for <a class="struct" href="../hyper/body/struct.Body.html" title="struct hyper::body::Body">Body</a></code><a href="#impl-From%3C%26%27static%20%5Bu8%5D%3E" class="anchor"></a><a class="srclink" href="../src/hyper/body/body.rs.html#497-502" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from-2" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(slice: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'static [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="struct" href="../hyper/body/struct.Body.html" title="struct hyper::body::Body">Body</a></code><a class="srclink" href="../src/hyper/body/body.rs.html#499-501" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>