Struct spirit_tokio::installer::FutureInstaller

pub struct FutureInstaller;

An installer able to install (an uninstall) long-running futures.

This is an installer that can be used with Fragment that produce futures.

• If the spirit does not contain a Tokio runtime yet, one (the default one) will be added as a singleton. Note that this has effect on how spirit manages lifetime of the application.
• An uninstallation is performed by dropping canceling the future.
• This works with both concrete types (implementing Future<Output = ()> + Send) and boxed ones. Note that the boxed ones are Pin<Box<dyn Future<Output = ()> + Send>>, created by Box::pin.

See the crate level examples for details how to use (the installer is used only as the associated type in the fragment implementation).

Trait Implementations

impl Clone for FutureInstaller

fn clone(&self) -> FutureInstaller

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FutureInstaller

impl Debug for FutureInstaller

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

Formats the value using the given formatter.

impl Default for FutureInstaller

fn default() -> FutureInstaller

Returns the "default value" for a type.

impl<F, O, C> Installer<F, O, C> for FutureInstaller where
    F: Future<Output = ()> + Send + 'static, 

type UninstallHandle = RemoteDrop

A handle representing lifetime of the resource.

fn install(&mut self, fut: F, name: &'static str) -> RemoteDrop

Installs another instance of the resource.

fn init<E>(&mut self, ext: E, _name: &'static str) -> Result<E, AnyError> where
    E: Extensible<Opts = O, Config = C, Ok = E>,
    E::Config: DeserializeOwned + Send + Sync + 'static,
    E::Opts: StructOpt + Send + Sync + 'static, 

Initialize the installer.