Struct Driver

pub struct Driver<T> { /* private fields */ }

An owned handle to a Driver instance that can be used to create initial dispatchers.

Implementations

impl<T: 'static> Driver<T>

pub fn new_dispatcher( &self, dispatcher: DispatcherBuilder, ) -> Result<DispatcherRef<'static>, Status>

Returns a builder capable of creating a new dispatcher. Note that this dispatcher cannot outlive the driver and is only capable of being stopped by shutting down the driver. It is meant to be created to serve as the initial or default dispatcher for a driver.

pub fn enter<R>(&mut self, f: impl FnOnce() -> R) -> R

Run a closure in the context of a driver.

pub fn add_allowed_scheduler_role(&self, scheduler_role: &str)

Adds an allowed scheduler role to the driver

pub fn shutdown<F: DriverShutdownObserverFn<T>>(self, f: F)

Asynchronously shuts down all dispatchers owned by |driver|. |f| will be called once shutdown completes. This is guaranteed to be after all the dispatcher’s shutdown observers have been called, and will be running on the thread of the final dispatcher which has been shutdown.

pub fn release(self) -> DriverRef<'static, T>

Releases ownership of this driver instance, allowing it to be shut down when the runtime shuts down.

Trait Implementations

impl<T: Debug> Debug for Driver<T>

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

Formats the value using the given formatter.

impl<T> Drop for Driver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> PartialEq<UnownedDriver> for Driver<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Send> Send for Driver<T>

SAFETY: This inner pointer is movable across threads.