actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2025-07-01 01:04:27 +02:00
Code Issues Releases Wiki Activity

update stable docs

Browse Source
This commit is contained in:
Nikolay Kim
2018-07-26 10:53:41 -07:00
parent 0c2153597f
commit 90165ac1cc
2025 changed files with 116162 additions and 2957 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
static/api/actix-web/stable/actix_web/dev/struct.Payload.html
View File

@ -18,7 +18,7 @@ generation.</p>
<p><code>Payload</code> - <em>Receiver</em> side of the stream</p>
</li>
</ul>
</div><h4 id='method.unread_data' class="method"><span id='unread_data.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.unread_data' class='fnname'>unread_data</a>(&amp;mut self, data: <a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#76-78' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Put unused data back to payload</p>
</div><h4 id='method.unread_data' class="method"><span id='unread_data.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.unread_data' class='fnname'>unread_data</a>(&amp;mut self, data: <a class="struct" href="https://docs.rs/bytes/0.4.9/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#76-78' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Put unused data back to payload</p>
</div><h4 id='method.set_read_buffer_capacity' class="method"><span id='set_read_buffer_capacity.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_read_buffer_capacity' class='fnname'>set_read_buffer_capacity</a>(&amp;mut self, cap: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#89-91' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set read buffer capacity</p>
<p>Default buffer capacity is 32Kb.</p>
</div></div>
@ -26,11 +26,11 @@ generation.</p>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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="../../actix_web/dev/struct.Payload.html" title="struct actix_web::dev::Payload">Payload</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#29' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><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>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#29' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><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-Stream' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a> for <a class="struct" href="../../actix_web/dev/struct.Payload.html" title="struct actix_web::dev::Payload">Payload</a></code><a href='#impl-Stream' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#94-102' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item' class="type">Item</a> = <a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a></code></span></h4>
</div></div><h3 id='impl-Stream' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a> for <a class="struct" href="../../actix_web/dev/struct.Payload.html" title="struct actix_web::dev::Payload">Payload</a></code><a href='#impl-Stream' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#94-102' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item' class="type">Item</a> = <a class="struct" href="https://docs.rs/bytes/0.4.9/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a></code></span></h4>
<div class='docblock'><p>The type of item this stream will yield on success.</p>
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a></code></span></h4>
<div class='docblock'><p>The type of error this stream may generate.</p>
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#tymethod.poll' class='fnname'>poll</a>(&amp;mut self) -&gt; <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</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="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>&gt;, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#99-101' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempt to pull out the next value of this stream, returning <code>None</code> if the stream is finished. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#tymethod.poll">Read more</a></p>
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#tymethod.poll' class='fnname'>poll</a>(&amp;mut self) -&gt; <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</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="https://docs.rs/bytes/0.4.9/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>&gt;, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#99-101' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempt to pull out the next value of this stream, returning <code>None</code> if the stream is finished. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#tymethod.poll">Read more</a></p>
</div><h4 id='method.wait' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a>&lt;S&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a>&lt;S&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;S&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a>&lt;S&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>,&nbsp;</span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;&lt;S as <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>&gt;::<a class="type" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>, &lt;S as <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>&gt;::<a class="type" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>&gt;;</span></code></div></div><span id='wait.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.wait' class='fnname'>wait</a>(self) -&gt; <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#244-248' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an iterator which blocks the current thread until each item of this stream is resolved. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.wait">Read more</a></p>
</div><h4 id='method.into_future' class="method"><span id='into_future.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.into_future' class='fnname'>into_future</a>(self) -&gt; <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/future/struct.StreamFuture.html" title="struct futures::stream::future::StreamFuture">StreamFuture</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#291-295' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts this stream into a <code>Future</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.into_future">Read more</a></p>
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map' class='fnname'>map</a>&lt;U, F&gt;(self, f: F) -&gt; <a class="struct" href="https://docs.rs/futures/0.1/futures/stream/map/struct.Map.html" title="struct futures::stream::map::Map">Map</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="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>) -&gt; U,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://docs.rs/futures/0.1/src/futures/stream/mod.rs.html#316-321' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Converts a stream of type <code>T</code> to a stream of type <code>U</code>. <a href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html#method.map">Read more</a></p>