Struct Dispatcher

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

An owned handle for a dispatcher managed by the driver runtime.

Implementations

impl Dispatcher

pub unsafe fn from_raw(handle: NonNull<fdf_dispatcher>) -> Dispatcher

Creates a dispatcher ref from a raw handle.

Safety

Caller is responsible for ensuring that the given handle is valid and not owned by any other wrapper that will free it at an arbitrary time.

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 post_task_sync(&self, p: impl TaskCallback) -> Result<(), Status>

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

pub fn release(self) -> DispatcherRef<'static>

Releases ownership over this dispatcher and returns a DispatcherRef that can be used to access it. The lifetime of this reference is static because it will exist so long as this current driver is loaded, but the driver runtime will shut it down when the driver is unloaded.

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

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

Trait Implementations

impl Debug for Dispatcher

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

Formats the value using the given formatter.

impl Drop for Dispatcher

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> OnDispatcher for &'a Dispatcher

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

Runs the function f with a lifetime-bound DispatcherRef 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(DispatcherRef<'_>) -> 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.

impl Send for Dispatcher

impl Sync for Dispatcher