Struct h2::server::SendResponse
source · pub struct SendResponse<B: Buf> { /* private fields */ }Expand description
Send a response back to the client
A SendResponse instance is provided when receiving a request and is used
to send the associated response back to the client. It is also used to
explicitly reset the stream with a custom reason.
It will also be used to initiate push promises linked with the associated stream.
If the SendResponse instance is dropped without sending a response, then
the HTTP/2 stream will be reset.
See module level docs for more details.
Implementations§
source§impl<B: Buf> SendResponse<B>
impl<B: Buf> SendResponse<B>
sourcepub fn send_response(
&mut self,
response: Response<()>,
end_of_stream: bool,
) -> Result<SendStream<B>, Error>
pub fn send_response( &mut self, response: Response<()>, end_of_stream: bool, ) -> Result<SendStream<B>, Error>
Send a response to a client request.
On success, a SendStream instance is returned. This instance can be
used to stream the response body and send trailers.
If a body or trailers will be sent on the returned SendStream
instance, then end_of_stream must be set to false when calling this
function.
The SendResponse instance is already associated with a received
request. This function may only be called once per instance and only if
send_reset has not been previously called.
sourcepub fn push_request(
&mut self,
request: Request<()>,
) -> Result<SendPushedResponse<B>, Error>
pub fn push_request( &mut self, request: Request<()>, ) -> Result<SendPushedResponse<B>, Error>
Push a request and response to the client
On success, a SendResponse instance is returned.
sourcepub fn send_reset(&mut self, reason: Reason)
pub fn send_reset(&mut self, reason: Reason)
Send a stream reset to the peer.
This essentially cancels the stream, including any inbound or outbound data streams.
If this function is called before send_response, a call to
send_response will result in an error.
If this function is called while a SendStream instance is active,
any further use of the instance will result in an error.
This function should only be called once.
sourcepub fn poll_reset(
&mut self,
cx: &mut Context<'_>,
) -> Poll<Result<Reason, Error>>
pub fn poll_reset( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Reason, Error>>
Polls to be notified when the client resets this stream.
If stream is still open, this returns Poll::Pending, and
registers the task to be notified if a RST_STREAM is received.
If a RST_STREAM frame is received for this stream, calling this
method will yield the Reason for the reset.
§Error
Calling this method after having called send_response will return
a user error.