pub struct StreamingBody { /* private fields */ }
Expand description
A streaming HTTP body that can be written to, or appended to from another body.
The interface to this type is very similar to Body
, however it is write-only, and can only be
created as a result of calling
Response::stream_to_client()
or
Request::send_async_streaming()
.
The most efficient way to write the body is through the Write
implementation. Writes are
buffered, and automatically flushed, but you can call Write::flush()
to explicitly flush the
buffer and cause a new chunk to be written to the client.
A streaming body will be automatically closed when it goes out of scope, or when it is passed to
drop()
.
Implementations
sourceimpl StreamingBody
impl StreamingBody
sourcepub fn append(&mut self, other: Body)
pub fn append(&mut self, other: Body)
Append a body onto the end of this streaming body.
This operation is performed in amortized constant time, and so should always be preferred to reading an entire body and then writing the same contents to another body.
Examples
let mut streaming_body = beresp.stream_to_client();
streaming_body.append(other_body);
Trait Implementations
sourceimpl From<StreamingBodyHandle> for StreamingBody
impl From<StreamingBodyHandle> for StreamingBody
sourcefn from(handle: StreamingBodyHandle) -> Self
fn from(handle: StreamingBodyHandle) -> Self
Performs the conversion.
sourceimpl Write for StreamingBody
impl Write for StreamingBody
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations
impl RefUnwindSafe for StreamingBody
impl Send for StreamingBody
impl Sync for StreamingBody
impl Unpin for StreamingBody
impl UnwindSafe for StreamingBody
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more