Struct fastly::http::body::StreamingBody

pub struct StreamingBody { /* private fields */ }

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 handle will be automatically aborted if it goes out of scope without calling finish().

Implementations

impl StreamingBody

pub fn finish(self) -> Result<()>

Finish writing to a streaming body handle.

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);

pub fn write_bytes(&mut self, bytes: &[u8]) -> usize

👎Deprecated since 0.10.0: use std::io::Write::write() instead

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]);

pub fn write_str(&mut self, string: &str) -> usize

👎Deprecated since 0.10.0: use std::io::Write::write() instead

Write a string slice 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_str("woof woof");

Trait Implementations

impl From<StreamingBodyHandle> for StreamingBody

fn from(handle: StreamingBodyHandle) -> Self

Converts to this type from the input type.

impl StreamingBodyExt for StreamingBody

fn append_trailer(&mut self, name: impl ToHeaderName, value: impl ToHeaderValue)

Append the given trailer name and value to this body.

fn finish_with_trailers(self, trailers: &HeaderMap) -> Result<(), Error>

Get the trailers associated with this body.

impl Write for StreamingBody

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.