Struct abscissa_tokio::TokioComponent

pub struct TokioComponent { /* fields omitted */ }

Component which manages initialization of a Tokio runtime within the Abscissa application lifecycle.

See this crate's toplevel documentation for detailed usage notes.

Methods

impl TokioComponent

pub fn new() -> Result<Self, FrameworkError>

Create a new Tokio runtime component with the default options

pub fn runtime(&self) -> Result<&Runtime, FrameworkError>

Borrow the runtime, to e.g. ::spawn a future on it.

Returns an error if the runtime has already been taken.

pub fn runtime_mut(&mut self) -> Result<&mut Runtime, FrameworkError>

Borrow the runtime mutably (e.g. to block_on it during startup).

NOTE: If you are trying to transfer control of your application to the Tokio runtime, use the abscissa_tokio::run function instead.

Returns an error if the runtime has already been taken.

Trait Implementations

impl<A> Component<A> for TokioComponent where
    A: Application, 

fn id(&self) -> Id

Identifier for this component

fn version(&self) -> Version

Version of this component

fn after_config(
    &mut self,
    config: &<A as Application>::Cfg
) -> Result<(), FrameworkError>

Lifecycle event called when application configuration should be loaded if it were possible.

fn dependencies(&self) -> Iter<Id>

Names of the components this component depends on.

fn register_dependency(
    &mut self,
    handle: Handle,
    dependency: &mut (dyn Component<A> + 'static)
) -> Result<(), FrameworkError>

Register a dependency of this component (a.k.a. "dependency injection")

fn before_shutdown(&self, kind: Shutdown) -> Result<(), FrameworkError>

Perform any tasks which should occur before the app exits

impl Debug for TokioComponent

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

Formats the value using the given formatter.

impl From<Runtime> for TokioComponent

fn from(runtime: Runtime) -> Self

Performs the conversion.