mirror of
https://github.com/actix/actix-website
synced 2025-07-01 01:04:27 +02:00
update stable docs
This commit is contained in:
@ -3,18 +3,18 @@
|
||||
<h2 id='methods' class='small-section-header'>
|
||||
Methods<a href='#methods' class='anchor'></a>
|
||||
</h2>
|
||||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<S> <a class="struct" href="../../actix_web/dev/struct.PayloadBuffer.html" title="struct actix_web::dev::PayloadBuffer">PayloadBuffer</a><S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = <a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, Error = <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>>, </span></code><a href='#impl' 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#290-519' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(stream: S) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#295-301' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create new <code>PayloadBuffer</code> instance</p>
|
||||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<S> <a class="struct" href="../../actix_web/dev/struct.PayloadBuffer.html" title="struct actix_web::dev::PayloadBuffer">PayloadBuffer</a><S> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://docs.rs/futures/0.1/futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = <a class="struct" href="https://docs.rs/bytes/0.4.9/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>, Error = <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>>, </span></code><a href='#impl' 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#290-519' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(stream: S) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#295-301' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create new <code>PayloadBuffer</code> instance</p>
|
||||
</div><h4 id='method.get_mut' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </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> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='get_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>S</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#304-306' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get mutable reference to an inner stream.</p>
|
||||
</div><h4 id='method.readany' class="method"><span id='readany.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.readany' class='fnname'>readany</a>(&mut self) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#323-334' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read first available chunk of bytes</p>
|
||||
</div><h4 id='method.readany' class="method"><span id='readany.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.readany' class='fnname'>readany</a>(&mut self) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.9/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#323-334' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read first available chunk of bytes</p>
|
||||
</div><h4 id='method.can_read' class="method"><span id='can_read.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.can_read' class='fnname'>can_read</a>(&mut self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#338-348' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Check if buffer contains enough bytes</p>
|
||||
</div><h4 id='method.get_chunk' class="method"><span id='get_chunk.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get_chunk' class='fnname'>get_chunk</a>(&mut self) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</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>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#352-364' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return reference to the first chunk of data</p>
|
||||
</div><h4 id='method.read_exact' class="method"><span id='read_exact.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_exact' class='fnname'>read_exact</a>(&mut self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#368-399' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read exact number of bytes</p>
|
||||
</div><h4 id='method.read_exact' class="method"><span id='read_exact.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_exact' class='fnname'>read_exact</a>(&mut self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.9/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#368-399' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read exact number of bytes</p>
|
||||
</div><h4 id='method.drop_bytes' class="method"><span id='drop_bytes.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.drop_bytes' class='fnname'>drop_bytes</a>(&mut self, size: <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#403-418' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Remove specified amount if bytes from buffer</p>
|
||||
</div><h4 id='method.copy' class="method"><span id='copy.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.copy' class='fnname'>copy</a>(&mut self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.BytesMut.html" title="struct bytes::bytes::BytesMut">BytesMut</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#421-440' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Copy buffered data</p>
|
||||
</div><h4 id='method.read_until' class="method"><span id='read_until.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_until' class='fnname'>read_until</a>(&mut self, line: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</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>) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#443-496' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read until specified ending</p>
|
||||
</div><h4 id='method.readline' class="method"><span id='readline.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.readline' class='fnname'>readline</a>(&mut self) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.8/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#499-501' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read bytes until new line delimiter</p>
|
||||
</div><h4 id='method.unprocessed' class="method"><span id='unprocessed.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.unprocessed' class='fnname'>unprocessed</a>(&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#504-507' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Put unprocessed data back to the buffer</p>
|
||||
</div><h4 id='method.remaining' class="method"><span id='remaining.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.remaining' class='fnname'>remaining</a>(&mut self) -> <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#510-518' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get remaining data from the buffer</p>
|
||||
</div><h4 id='method.copy' class="method"><span id='copy.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.copy' class='fnname'>copy</a>(&mut self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.9/bytes/bytes/struct.BytesMut.html" title="struct bytes::bytes::BytesMut">BytesMut</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#421-440' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Copy buffered data</p>
|
||||
</div><h4 id='method.read_until' class="method"><span id='read_until.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_until' class='fnname'>read_until</a>(&mut self, line: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</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>) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.9/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#443-496' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read until specified ending</p>
|
||||
</div><h4 id='method.readline' class="method"><span id='readline.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.readline' class='fnname'>readline</a>(&mut self) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://docs.rs/bytes/0.4.9/bytes/bytes/struct.Bytes.html" title="struct bytes::bytes::Bytes">Bytes</a>>, <a class="enum" href="../../actix_web/error/enum.PayloadError.html" title="enum actix_web::error::PayloadError">PayloadError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/payload.rs.html#499-501' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read bytes until new line delimiter</p>
|
||||
</div><h4 id='method.unprocessed' class="method"><span id='unprocessed.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.unprocessed' class='fnname'>unprocessed</a>(&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#504-507' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Put unprocessed data back to the buffer</p>
|
||||
</div><h4 id='method.remaining' class="method"><span id='remaining.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.remaining' class='fnname'>remaining</a>(&mut self) -> <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#510-518' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get remaining data from the buffer</p>
|
||||
</div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||||
|
Reference in New Issue
Block a user