Skip to main content

CurrentDispatcher

libasync

Struct CurrentDispatcher 

Source 
pub struct CurrentDispatcher;
Expand description

A placeholder for the currently active dispatcher. Use GetAsyncDispatcher::get_async_dispatcher to access it when needed.

Implementations§

Source§

impl CurrentDispatcher

Source

pub unsafe fn set(dispatcher: &impl AsAsyncDispatcherRef)

Sets the currently active dispatcher for this thread.

§Safety

The caller must ensure that the dispatcher they set will be alive until it is Self::unset or Self::set to another value. Using Self::with is a safer way to use this api as it will use the current execution stack to ensure that it is properly unset.

Source

pub fn unset()

Unsets the currently active dispatcher whatever it is.

Source

pub fn with<R>( dispatcher: &impl AsAsyncDispatcherRef, f: impl FnOnce() -> R, ) -> R

Runs the passed function with the current dispatcher set to the one passed in, and then re-sets the dispatcher to whatever it was before.

Trait Implementations§

Source§

impl Clone for CurrentDispatcher

Source§

fn clone(&self) -> CurrentDispatcher

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 CurrentDispatcher

Source§

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

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

impl Default for CurrentDispatcher

Source§

fn default() -> CurrentDispatcher

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

impl GetAsyncDispatcher for CurrentDispatcher

Source§

fn try_get_async_dispatcher(&self) -> Option<AsyncDispatcher>

Returns a refcounted handle to the active dispatcher for this object, if there is one. Some types of dispatchers (like for the current dispatcher of a thread) may not always have an active dispatcher, so it is returned as an option.
Source§

fn get_async_dispatcher(&self) -> AsyncDispatcher

Returns a refcounted handle to the active dispatcher for this object. Read more
Source§

impl PartialEq for CurrentDispatcher

Source§

fn eq(&self, other: &CurrentDispatcher) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for CurrentDispatcher

Source§

impl StructuralPartialEq for CurrentDispatcher

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: GetAsyncDispatcher,

Source§

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

Returns a future that will fire when after the given deadline time. Read more
Source§

fn try_after_deadline( &self, deadline: Instant<MonotonicTimeline>, ) -> Option<AfterDeadline>

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<D> OnDispatcher for D
where D: GetAsyncDispatcher + Clone + Send + Sync,

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 D: '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, D: '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.