Enum ResponseBodyPipe

pub enum ResponseBodyPipe {
    Http1(Arc<Mutex<Encryption>>),
    Http2(SendStream<Bytes>, H2SendResponse),
    Http3(Box<RequestStream<SendStream<Bytes>, Bytes>>),
}

A pipe to send a body after the Response is sent by ResponsePipe::send_response.

The AsyncWriteExt::shutdown does nothing, and will immediately return with Ok(())

Variants

Http1(Arc<Mutex<Encryption>>)

HTTP/1 pipe

Http2(SendStream<Bytes>, H2SendResponse)

Available on crate feature http2 only.

HTTP/2 pipe

Http3(Box<RequestStream<SendStream<Bytes>, Bytes>>)

Available on crate feature http3 only.

HTTP/3 pipe

Implementations

impl ResponseBodyPipe

pub async fn send(&mut self, data: Bytes) -> Result<(), Error>

Sends data as the body.

Errors

Passes any errors from writing to the stream. See AsyncWriteExt::write_all() and [h2::SendStream::send_data()].

pub async fn flush(&mut self) -> Result<(), Error>

Only does something for HTTP/1, since the other protocols are not implemented as streams.

To shut down the stream, it is necessary to call ResponseBodyPipe::close.

Errors

Passes any errors from flushing the stream.

pub async fn send_with_wait( &mut self, data: Bytes, _chunk_size: usize, ) -> Result<(), Error>

Same as ResponseBodyPipe::send but tries its best to wait for the data to actually be sent, freeing up previous Bytes being sent before.

chunk_size is the expected size of data used to negotiate and wait for capacity changes. A value of ~10MB is often good (chunk_size is measured in bytes).

Errors

Same as ResponseBodyPipe::send.

pub fn push_request( &mut self, request: Request<()>, ) -> Result<PushedResponsePipe, Error>

Pushes request to client.

Errors

If you try to push if self is ResponsePipe::Http1, an Error::UnsupportedPush is returned. Returns errors from [h2::server::SendResponse::push_request()].

pub async fn close(&mut self) -> Result<(), Error>

Closes the pipe.

Errors

Passes any errors emitted when closing the writer. See AsyncWriteExt::flush() and [h2::SendStream::send_data()].

Trait Implementations

impl Debug for ResponseBodyPipe

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.