Skip to main content

AsyncDispatcher

Struct AsyncDispatcher 

Source
pub struct AsyncDispatcher(/* private fields */);
Expand description

A reference to a dispatcher that supports the v4 async api’s reference counting operations, and so can be held safely without a lifetime.

Implementations§

Source§

impl AsyncDispatcher

Source

pub fn new(dispatcher: &impl AsAsyncDispatcherRef) -> AsyncDispatcher

Converts from something that implements AsAsyncDispatcherRef to an AsyncDispatcher if it implements the v4 async api’s reference counting.

§Panics

This will panic if the implementation does not support reference counting. If you need to be able to deal with a dispatcher that might not implement this api, you can use AsyncDispatcher::new.

Source

pub fn try_new( dispatcher: &impl AsAsyncDispatcherRef, ) -> Result<AsyncDispatcher, Status>

Converts from something that implements AsAsyncDispatcherRef to an AsyncDispatcher if it implements the v4 async api’s reference counting.

Returns [Status::UNSUPPORTED] if the dispatcher does not support refcounting.

Trait Implementations§

Source§

impl AsAsyncDispatcherRef for AsyncDispatcher

Source§

fn as_async_dispatcher_ref(&self) -> AsyncDispatcherRef<'_>

Gets an AsyncDispatcherRef corresponding to this object.
Source§

fn post_task_sync(&self, p: impl TaskCallback) -> Result<(), Status>

Schedules the callback [p] to be run on this dispatcher later.
Source§

fn now(&self) -> i64

Returns the current time on the dispatcher’s timeline
Source§

impl Clone for AsyncDispatcher

Source§

fn clone(&self) -> AsyncDispatcher

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 Debug for AsyncDispatcher

Source§

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

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

impl Drop for AsyncDispatcher

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
Source§

impl Send for AsyncDispatcher

Source§

impl Sync for AsyncDispatcher

Auto Trait Implementations§

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> DispatcherTimerExt for T
where T: OnDispatcher,

Source§

fn after_deadline( &self, deadline: Instant<MonotonicTimeline>, ) -> AfterDeadline<T>

Returns a future that will fire when after the given deadline time. 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> OnDispatcher for T

Source§

fn on_dispatcher<R>( &self, f: impl FnOnce(Option<AsyncDispatcherRef<'_>>) -> R, ) -> R

Runs the function f with a lifetime-bound AsyncDispatcherRef for this object’s dispatcher. If the dispatcher is no longer valid, the callback will be given None. Read more
Source§

fn on_maybe_dispatcher<R, E>( &self, f: impl FnOnce(AsyncDispatcherRef<'_>) -> Result<R, E>, ) -> Result<R, E>
where E: From<Status>,

Helper version of OnDispatcher::on_dispatcher that translates an invalidated dispatcher handle into a [Status::BAD_STATE] error instead of giving the callback None. Read more
Source§

fn spawn( &self, future: impl Future<Output = ()> + Send + 'static, ) -> JoinHandle<()>
where Self: 'static,

Spawn an asynchronous task on this dispatcher. If this returns Ok then the task has successfully been scheduled and will run or be cancelled and dropped when the dispatcher shuts down. The returned future’s result will be Ok if the future completed successfully, or an Err if the task did not complete for some reason (like the dispatcher shut down). Read more
Source§

fn compute<T>( &self, future: impl Future<Output = T> + Send + 'static, ) -> Task<T>
where T: Send + 'static, Self: 'static,

Spawn an asynchronous task that outputs type ‘T’ on this dispatcher. The returned future’s result will be Ok if the task was started and completed successfully, or an Err if the task couldn’t be started or failed to complete (for example because the dispatcher was shutting down). Read more
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.