Struct Unsolicited 

pub struct Unsolicited { /* private fields */ }

A queue of frames the peer pushed while some other call was in flight.

Draining rather than cloning: the frames are the peer’s, and a caller that polls in a loop should get each one exactly once.

Implementations

impl Unsolicited

pub fn new() -> Self

An empty queue.

pub fn hold(&self, frame: Map<String, Value>)

Parks a frame that no call was waiting for.

A poisoned lock is a frame not parked. It is dropped rather than reported because the caller is in the middle of a call and has no way to act on a queue fault; the alternative — panicking — would take the bridge down over a bookkeeping problem.

pub fn take(&self) -> Vec<Map<String, Value>>

Takes everything held so far, leaving the queue empty.

pub fn wait(&self) -> impl Future<Output = ()> + Send + 'static

Resolves once something has been parked here.

A queue that is already non-empty resolves on the first poll, which is what stops a caller parking a frame between its own take and its first poll from waiting for a wake-up that has already happened.

No #[must_use] here: the returned future is itself #[must_use], so a second copy of the attribute adds nothing this signature does not already say.

pub fn len(&self) -> usize

How many frames are waiting.

pub fn is_empty(&self) -> bool

Whether nothing is waiting.

Trait Implementations

impl Debug for Unsolicited

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

Formats the value using the given formatter.

impl Default for Unsolicited

fn default() -> Self

Returns the “default value” for a type.