Struct async_injector::Injector

pub struct Injector { /* fields omitted */ }

Use for handling injection.

Methods

impl Injector

pub fn new() -> Self

Create a new injector instance.

pub fn child(&self) -> Injector

Construct a new child injector.

When a child injector is dropped, all associated listeners are cleaned up as well.

pub async fn clear<'_, T>(&'_ self) where
    T: Clone + Any + Send + Sync + 'static, 

Clear the given value.

pub async fn clear_key<'_, T>(&'_ self, key: impl AsRef<Key<T>>) where
    T: Clone + Any + Send + Sync + 'static, 

Clear the given value.

pub async fn update<'_, T>(&'_ self, value: T) where
    T: Any + Send + Sync + 'static + Clone, 

Set the given value and notify any subscribers.

pub async fn update_key<'_, T>(&'_ self, key: impl AsRef<Key<T>>, value: T) where
    T: Any + Send + Sync + 'static + Clone, 

Set the given value and notify any subscribers.

pub async fn get<'_, T>(&'_ self) -> Option<T> where
    T: Any + Send + Sync + 'static + Clone, 

Get a value from the injector.

pub async fn get_key<'_, T>(&'_ self, key: impl AsRef<Key<T>>) -> Option<T> where
    T: Any + Send + Sync + 'static + Clone, 

Get a value from the injector with the given key.

pub async fn stream<'_, T>(&'_ self) -> (Stream<T>, Option<T>) where
    T: Any + Send + Sync + 'static + Clone, 

Get an existing value and setup a stream for updates at the same time.

pub async fn stream_key<'_, T>(
    &'_ self,
    key: impl AsRef<Key<T>>
) -> (Stream<T>, Option<T>) where
    T: Any + Send + Sync + 'static + Clone, 

Get an existing value and setup a stream for updates at the same time.

pub async fn var<'_, T>(&'_ self) -> Result<Var<Option<T>>, Error> where
    T: Any + Send + Sync + 'static + Clone + Unpin, 

Get a synchronized variable for the given configuration key.

pub async fn var_key<'_, T>(
    &'_ self,
    key: impl AsRef<Key<T>>
) -> Result<Var<Option<T>>, Error> where
    T: Any + Send + Sync + 'static + Clone + Unpin, 

Get a synchronized variable for the given configuration key.

pub async fn drive(self) -> Result<(), Error>

Run the injector as a future, making sure all asynchronous processes associated with it are driven to completion.

This has to be called for the injector to perform important tasks.

Trait Implementations

impl Clone for Injector

fn clone(&self) -> Injector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Injector

fn default() -> Self

Returns the "default value" for a type.