Struct RpcStream 

pub struct RpcStream { /* private fields */ }

An open streaming RPC call. Implements Stream<Item = Result<Bytes, RpcError>> — yields chunks as the server emits them, terminates on a clean stream-end frame OR a non-Ok status (which is yielded as the last Err item before the stream closes).

Dropping the stream emits a CANCEL to the server (best-effort) and discards the pending entry — any chunks the server emits after the drop are silently discarded by the client fold.

Implementations

impl RpcStream

pub fn call_id(&self) -> u64

Server-assigned call_id. Useful for trace correlation / custom logging at the call site.

pub fn flow_controlled(&self) -> bool

Whether this stream is flow-controlled (caller set CallOptions::stream_window_initial). Useful for tests + diagnostics; user code typically doesn’t need to inspect this.

pub fn grant(&self, amount: u32)

Explicitly grant amount more credits to the server’s pump. Spawns a fire-and-forget publish; doesn’t await acknowledgement. No-op when flow control was not enabled for this stream — the server would silently drop the grant anyway, and emitting wire traffic with no purpose would just burn bandwidth.

Auto-grant (1 credit per delivered chunk) covers the common case; use this for batched cadence (e.g. grant window/2 after every window/2 chunks consumed) when auto_grant-style amortization isn’t enough.

Trait Implementations

impl Drop for RpcStream

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Stream for RpcStream

type Item = Result<Bytes, RpcError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.