Struct h2::server::SendPushedResponse

pub struct SendPushedResponse<B: Buf> { /* private fields */ }

Send a response to a promised request

A SendPushedResponse instance is provided when promising a request and is used to send the associated response to the client. It is also used to explicitly reset the stream with a custom reason.

It can not be used to initiate push promises.

If the SendPushedResponse instance is dropped without sending a response, then the HTTP/2 stream will be reset.

See module level docs for more details.

Implementations

impl<B: Buf> SendPushedResponse<B>

pub fn send_response(
    &mut self,
    response: Response<()>,
    end_of_stream: bool
) -> Result<SendStream<B>, Error>

Send a response to a promised 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 SendPushedResponse instance is associated with a promised request. This function may only be called once per instance and only if send_reset has not been previously called.

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.

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.

pub fn stream_id(&self) -> StreamId

Returns the stream ID of the response stream.

Panics

If the lock on the stream store has been poisoned.

Trait Implementations

impl<B: Buf + Debug> Debug for SendPushedResponse<B>

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

Formats the value using the given formatter.