Struct RequestStream

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

Available on crate feature h3 only.

Manage request and response transfer for an incoming request

The RequestStream struct is used to send and/or receive information from the client. After sending the final response, call RequestStream::finish to close the stream.

Implementations

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

where S: RecvStream, B: Buf,

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

Receive data sent from the client

pub fn poll_recv_data( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Option<impl Buf>, StreamError>>

Poll for data sent from the client

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

Receive an optional set of trailers for the request

pub fn poll_recv_trailers( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Option<HeaderMap>, StreamError>>

Poll for an optional set of trailers for the request

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

Tell the peer to stop sending into the underlying QUIC stream

pub fn id(&self) -> StreamId

Returns the underlying stream id

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

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

pub async fn send_response( &mut self, resp: Response<()>, ) -> Result<(), StreamError>

Send the HTTP/3 response

This should be called before trying to send any data with RequestStream::send_data.

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

Send some data on the response body.

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

Stop a stream with an error code

The code can be Code::H3_NO_ERROR.

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

Send a set of trailers to end the response.

RequestStream::finish must be called to finalize a request.

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

End the response without trailers.

RequestStream::finish must be called to finalize a request.

pub fn send_id(&self) -> StreamId

Returns the underlying stream id

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

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

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

Splits the Request-Stream into send and receive. This can be used the send and receive data on different tasks.

Trait Implementations

impl<S, B> AsMut<RequestStream<S, B>> for RequestStream<S, B>

fn as_mut(&mut self) -> &mut RequestStream<S, B>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S, B> CloseStream for RequestStream<S, B>

fn handle_connection_error_on_stream( &mut self, internal_error: InternalConnectionError, ) -> StreamError

Handles a connection error on a stream

fn handle_quic_stream_error(&self, error: StreamErrorIncoming) -> StreamError

Handles a incoming stream error from the quic layer

fn check_peer_connection_closing(&self) -> Option<StreamError>

Checks if the peer connection is closing an if it is allowed to send a request / server push

impl<S, B> ConnectionState for RequestStream<S, B>

fn shared_state(&self) -> &SharedState

Get the shared state

fn get_conn_error(&self) -> Option<ErrorOrigin>

Get the connection error if the connection is in error state because of another task

fn set_conn_error(&self, error: ErrorOrigin) -> ErrorOrigin

tries to set the connection error

fn set_conn_error_and_wake<T>(&self, error: T) -> ErrorOrigin

where T: Into<ErrorOrigin>,

set the connection error and wake the connection

fn settings(&self) -> Cow<'_, Settings>

Get the settings

fn set_closing(&self)

Set the connection to closing

fn is_closing(&self) -> bool

Check if the connection is closing

fn set_settings(&self, settings: Settings)

Set the settings

fn waker(&self) -> &AtomicWaker

Returns the waker for the connection