Struct grpc::ServerResponseSink

pub struct ServerResponseSink<Resp: Send + 'static> { /* fields omitted */ }

Sink for server gRPC response.

Methods

impl<Resp: Send> ServerResponseSink<Resp>

pub fn poll(&mut self, cx: &mut Context) -> Poll<Result<(), StreamDead>>

This method returns Poll::Ready when the sink is available to accept data otherwise subscribe current task which will be notified when this stream is ready to accept data.

Higher level wrapper (future) is ready.

pub async fn ready<'_>(&'_ mut self) -> Result<(), StreamDead>

A future is resolved when the sink is available to receive more data.

pub fn send_metadata(&mut self, metadata: Metadata) -> Result<()>

Send response metadata.

This function returns error if metadata is already sent.

pub fn send_data(&mut self, message: Resp) -> Result<()>

Send response data.

This function does not block, but if send window is not available, data is queued.

ready function can be used to wait for windows availability.

pub fn send_trailers(&mut self, metadata: Metadata) -> Result<()>

Send trailers after the response.

This function must be called after data is sent, otherwise the response stream is reset.

pub fn send_grpc_error(
    &mut self,
    status: GrpcStatus,
    message: String
) -> Result<()>

Send error.