Struct DispatcherRef 

pub struct DispatcherRef<'a>(/* private fields */);

An unowned reference to a driver runtime dispatcher such as is produced by calling Dispatcher::release. When this object goes out of scope it won’t shut down the dispatcher, leaving that up to the driver runtime or another owner.

Implementations

impl<'a> DispatcherRef<'a>

pub unsafe fn from_raw(handle: NonNull<fdf_dispatcher>) -> DispatcherRef<'a>

Creates a dispatcher ref from a raw handle.

Safety

Caller is responsible for ensuring that the given handle is valid for the lifetime 'a.

pub fn from_async_dispatcher( dispatcher: AsyncDispatcherRef<'a>, ) -> DispatcherRef<'a>

Creates a dispatcher ref from an AsyncDispatcherRef.

Panics

Note that this will cause an assert if the AsyncDispatcherRef was not created from a driver dispatcher in the first place.

Methods from Deref<Target = Dispatcher>

pub fn is_unsynchronized(&self) -> bool

Whether this dispatcher’s tasks and futures can run on multiple threads at the same time.

pub fn allows_thread_blocking(&self) -> bool

Whether this dispatcher is allowed to call blocking functions or not

pub fn is_current_dispatcher(&self) -> bool

Whether this is the dispatcher the current thread is running on

pub fn as_dispatcher_ref(&self) -> DispatcherRef<'_>

Returns a DispatcherRef that references this dispatcher with a lifetime constrained by self.

Trait Implementations

impl<'a> AsyncDispatcher for DispatcherRef<'a>

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

Gets an AsyncDispatcherRef corresponding to this object.

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

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

fn now(&self) -> Instant<MonotonicTimeline>

Returns the current time on the dispatcher’s timeline

impl<'a> Clone for DispatcherRef<'a>

fn clone(&self) -> DispatcherRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DispatcherRef<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for DispatcherRef<'a>

type Target = Dispatcher

The resulting type after dereferencing.

fn deref(&self) -> &<DispatcherRef<'a> as Deref>::Target

Dereferences the value.

impl<'a> DerefMut for DispatcherRef<'a>

fn deref_mut(&mut self) -> &mut <DispatcherRef<'a> as Deref>::Target

Mutably dereferences the value.

impl<'a> OnDispatcher for DispatcherRef<'a>

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( &self, future: impl Future<Output = ()> + Send + 'static, ) -> Result<JoinHandle<()>, 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. 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).

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

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

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