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);
sourcepub fn write_bytes(&mut self, bytes: &[u8]) -> usize
pub fn write_bytes(&mut self, bytes: &[u8]) -> usize
Write a slice of bytes to the end of this streaming body, and return the number of bytes written.
Examples
let mut streaming_body = resp.stream_to_client();
streaming_body.write_bytes(&[0, 1, 2, 3]);
Trait Implementations
sourceimpl From<StreamingBodyHandle> for StreamingBody
impl From<StreamingBodyHandle> for StreamingBody
sourcefn from(handle: StreamingBodyHandle) -> Self
fn from(handle: StreamingBodyHandle) -> Self
sourceimpl Write for StreamingBody
impl Write for StreamingBody
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
sourcefn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>
fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
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
)