Skip to main content

Handle

Struct Handle 

Source
pub struct Handle<T, U> { /* private fields */ }
Expand description

Drives a paired Mock.

A Handle receives the requests made to its Mock (via next_request/poll_request, each of which yields a SendResponse for replying), can fail the mock’s readiness with send_error, and can limit how many requests the mock accepts with allow.

Implementations§

Source§

impl<T, U> Handle<T, U>

Source

pub fn poll_request(&mut self) -> Poll<Option<(T, SendResponse<U>)>>

Polls for the next request made to the Mock.

On Ready, yields the request together with a SendResponse used to reply to it, or None once every Mock clone has been dropped.

Source

pub async fn next_request(&mut self) -> Option<(T, SendResponse<U>)>

Waits for the next request made to the Mock.

Resolves to the request together with a SendResponse used to reply to it, or None once every Mock clone has been dropped.

Source

pub fn allow(&mut self, num: u64)

Allow the Mock to accept num more requests.

Once the mock has accepted that many requests, its poll_ready returns Pending until allow is called again. A newly-created mock starts out allowing u64::MAX requests, so this is only needed to exert backpressure in a test.

Source

pub fn send_error<E: Into<Box<dyn Error + Send + Sync>>>(&mut self, e: E)

Make the Mock’s next poll_ready resolve to the given error.

Trait Implementations§

Source§

impl<T: Debug, U: Debug> Debug for Handle<T, U>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T, U> Drop for Handle<T, U>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more

Auto Trait Implementations§

§

impl<T, U> Freeze for Handle<T, U>

§

impl<T, U> RefUnwindSafe for Handle<T, U>

§

impl<T, U> Send for Handle<T, U>
where T: Send, U: Send,

§

impl<T, U> Sync for Handle<T, U>
where T: Send, U: Send,

§

impl<T, U> Unpin for Handle<T, U>

§

impl<T, U> UnsafeUnpin for Handle<T, U>

§

impl<T, U> UnwindSafe for Handle<T, U>

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> 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, 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.