Struct WeakDispatcher 

pub struct WeakDispatcher(/* private fields */);

An unowned but reference counted reference to a dispatcher. This would usually come from an AutoReleaseDispatcher or from an existing Arc or Weak reference to a dispatcher.

The advantage to using this instead of using Weak directly is that it controls the lifetime of any given strong reference to the dispatcher, since the only way to access that strong reference is through OnDispatcher::on_dispatcher. This makes it much easier to be sure that you aren’t leaving any dangling strong references to the dispatcher object around.

Trait Implementations

impl Clone for WeakDispatcher

fn clone(&self) -> WeakDispatcher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WeakDispatcher

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

Formats the value using the given formatter.

impl From<&Arc<Dispatcher>> for WeakDispatcher

fn from(value: &Arc<Dispatcher>) -> Self

Converts to this type from the input type.

impl From<&AutoReleaseDispatcher> for WeakDispatcher

fn from(value: &AutoReleaseDispatcher) -> Self

Converts to this type from the input type.

impl From<Weak<Dispatcher>> for WeakDispatcher

fn from(value: Weak<Dispatcher>) -> Self

Converts to this type from the input type.

impl OnDispatcher for WeakDispatcher

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.

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.

fn spawn_task( &self, future: impl Future<Output = ()> + Send + 'static, ) -> Result<(), Status>

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.

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

Returns a future that will fire when after the given deadline time.