Struct async_injector::Ref

pub struct Ref<T> where
    T: Clone + Any + Send + Sync,  { /* fields omitted */ }

A variable allowing for the synchronized reading of avalue in the Injector.

This can be created through Injector::var or Injector::var_key.

Implementations

impl<T> Ref<T> where
    T: Clone + Any + Send + Sync, 

pub async fn read(&self) -> Option<RefReadGuard<'_, T>>

Read the synchronized variable.

Examples

use std::error::Error;

#[derive(Clone)]
struct Database;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let injector = async_injector::Injector::new();

    let database = injector.var::<Database>().await;

    assert!(database.read().await.is_none());
    injector.update(Database).await;
    assert!(database.read().await.is_some());
    Ok(())
}

pub async fn load(&self) -> Option<T>

Load the synchronized variable. This clones the underlying value if it has been set.

Examples

use std::error::Error;

#[derive(Clone)]
struct Database;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let injector = async_injector::Injector::new();

    let database = injector.var::<Database>().await;

    assert!(database.load().await.is_none());
    injector.update(Database).await;
    assert!(database.load().await.is_some());
    Ok(())
}

Trait Implementations

impl<T: Clone> Clone for Ref<T> where
    T: Clone + Any + Send + Sync, 

fn clone(&self) -> Ref<T>

Returns a copy of the value.

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

Performs copy-assignment from source.