Struct RequestStream 

pub struct RequestStream<S, B> { /* private fields */ }

Manage request bodies transfer, response and trailers.

Once a request has been sent via send_request(), a response can be awaited by calling recv_response(). A body for this request can be sent with send_data(), then the request shall be completed by either sending trailers with send_trailers(), or finish().

After receiving the response’s headers, it’s body can be read by recv_data() until it returns None. Then the trailers will eventually be available via recv_trailers().

TODO: If data is polled before the response has been received, an error will be thrown.

TODO: If trailers are polled but the body hasn’t been fully received, an UNEXPECT_FRAME error will be thrown

Whenever the client wants to cancel this request, it can call stop_sending(), which will put an end to any transfer concerning it.

Examples

// Prepare the HTTP request to send to the server
let request = Request::get("https://www.example.com/").body(())?;

// Receive the response
let response = req_stream.recv_response().await?;
// Receive the body
while let Some(mut chunk) = req_stream.recv_data().await? {
    let mut out = tokio::io::stdout();
    out.write_all_buf(&mut chunk).await?;
    out.flush().await?;
}

Implementations

impl<S, B> RequestStream<S, B>

where S: RecvStream,

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

Receive the HTTP/3 response

This should be called before trying to receive any data with recv_data().

pub async fn recv_data(&mut self) -> Result<Option<impl Buf>, Error>

Receive some of the request body.

pub async fn recv_trailers(&mut self) -> Result<Option<HeaderMap>, Error>

Receive an optional set of trailers for the response.

pub fn stop_sending(&mut self, error_code: Code)

Tell the peer to stop sending into the underlying QUIC stream

impl<S, B> RequestStream<S, B>

where S: SendStream<B>, B: Buf,

pub async fn send_data(&mut self, buf: B) -> Result<(), Error>

Send some data on the request body.

pub async fn send_trailers(&mut self, trailers: HeaderMap) -> Result<(), Error>

Send a set of trailers to end the request.

Either RequestStream::finish or RequestStream::send_trailers must be called to finalize a request.

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

End the request without trailers.

Either RequestStream::finish or RequestStream::send_trailers must be called to finalize a request.

impl<S, B> RequestStream<S, B>

where S: BidiStream<B>, B: Buf,

pub fn split( self, ) -> (RequestStream<S::SendStream, B>, RequestStream<S::RecvStream, B>)

Split this stream into two halves that can be driven independently.