Struct RequestSender 

pub struct RequestSender<Req> { /* private fields */ }

A handle for sending outbound request items over a streaming RPC.

Typically, you receive a RequestSender as the result of initiating a streaming RPC. Outbound messages are buffered and sent asynchronously to the server. The buffer size defaults to 16 and can be configured via RequestOptionsBuilder::with_request_stream_channel_capacity.

RequestSender is cheaply cloneable. Sending from multiple clones concurrently may interleave messages; if delivery order is important, send messages sequentially. The outbound request stream is closed once all clones of the RequestSender are dropped.

Examples

sender.send("message 1".to_string()).await?;
sender.send("message 2".to_string()).await?;
drop(sender); // Close outbound request stream

Implementations

impl<Req> RequestSender<Req>

pub async fn send(&self, item: Req) -> Result<(), SendError>

Sends a request item over the stream.

If the internal request buffer is full, this method awaits asynchronously until capacity is available. The buffer size defaults to 16 and can be configured via RequestOptionsBuilder::with_request_stream_channel_capacity.

Errors

• Returns SendError::StreamClosed if the stream was closed by the server or receiver.
• Returns SendError::Serialization if the request item cannot be serialized.

Examples

sender.send("hello".to_string()).await?;

Trait Implementations

impl<Req: Clone> Clone for RequestSender<Req>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Req> Debug for RequestSender<Req>

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

Formats the value using the given formatter.

impl<Req> From<Sender<Req>> for RequestSender<Req>

where Req: Send + 'static,

Creates a RequestSender from a Tokio mpsc::Sender, useful for mocking in tests.

Examples

let (tx, mut rx) = mpsc::channel::<String>(16);
let sender = RequestSender::from(tx);

fn from(req_tx: Sender<Req>) -> RequestSender<Req>

Converts to this type from the input type.