Skip to main content

PendingRequests

Struct PendingRequests 

Source
pub struct PendingRequests<K: Eq + Hash, R> { /* private fields */ }
Expand description

A registry of in-flight requests awaiting responses, keyed by K.

Cloning is cheap and shares all state: register a request on one clone and deliver its response from another. This is the expected way to use the registry across tasks (e.g. a reader task calling handle_response while many sender tasks await their ResponseWaiters).

Implementations§

Source§

impl<K: Eq + Hash + Clone, R> PendingRequests<K, R>

Source

pub fn new() -> Self

Create a registry with the default 6s timeout.

Source

pub fn set_timeout(&self, timeout: Duration)

Set the default timeout applied to requests registered after this call. Takes &self, so it works through a shared/cloned handle. Already-registered requests keep the timeout they were created with.

Source

pub fn timeout(&self) -> Duration

The current default timeout.

Source

pub fn len(&self) -> usize

Number of requests currently awaiting a response.

Source

pub fn is_empty(&self) -> bool

Whether there are no requests currently awaiting a response.

Source

pub fn contains(&self, key: &K) -> bool

Whether a request is currently pending for key.

Source

pub fn prepare_response(&self, key: K) -> Result<ResponseWaiter<K, R>, Error>

Register a request under key, using the registry’s default timeout.

Returns Error::KeyAlreadyExists if a request with key is already pending.

Source

pub fn prepare_response_with_timeout( &self, key: K, timeout: Duration, ) -> Result<ResponseWaiter<K, R>, Error>

Register a request under key with an explicit timeout.

Source

pub fn handle_response(&self, key: K, response: R) -> Result<(), Error>

Deliver response to the request registered under key.

Returns Error::KeyNotFound if no request is pending for key, or Error::ReceiverDropped if the waiter was already dropped.

Source

pub fn cancel(&self, key: &K) -> Result<(), Error>

Cancel the request registered under key, causing its waiter to resolve with Error::Canceled.

Returns Error::KeyNotFound if no request is pending for key.

Source

pub fn cancel_all(&self) -> usize

Cancel every pending request, resolving all their waiters with Error::Canceled. Returns the number of requests canceled.

Useful when a connection drops and all in-flight requests should fail at once.

Trait Implementations§

Source§

impl<K: Eq + Hash, R> Clone for PendingRequests<K, R>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K: Eq + Hash, R> Default for PendingRequests<K, R>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<K, R> !RefUnwindSafe for PendingRequests<K, R>

§

impl<K, R> !UnwindSafe for PendingRequests<K, R>

§

impl<K, R> Freeze for PendingRequests<K, R>

§

impl<K, R> Send for PendingRequests<K, R>
where K: Send, R: Send,

§

impl<K, R> Sync for PendingRequests<K, R>
where K: Send, R: Send,

§

impl<K, R> Unpin for PendingRequests<K, R>

§

impl<K, R> UnsafeUnpin for PendingRequests<K, R>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.