[][src]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
[src]

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

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>[src]

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
[src]

Auto Trait Implementations

impl<T> !RefUnwindSafe for Ref<T>[src]

impl<T> Send for Ref<T>[src]

impl<T> Sync for Ref<T>[src]

impl<T> Unpin for Ref<T> where
    T: Unpin
[src]

impl<T> !UnwindSafe for Ref<T>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.