Struct async_injector::Ref

source ·
pub struct Ref<T>
where T: Clone + Any + Send + Sync,
{ /* private fields */ }
Expand description

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

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

Implementations§

source§

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

source

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

Read the synchronized variable.

Examples
use async_injector::Injector;

#[derive(Clone)]
struct Database;

let 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());
source

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

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

Examples
use async_injector::Injector;

#[derive(Clone)]
struct Database;

let 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());

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Ref<T>

§

impl<T> Send for Ref<T>

§

impl<T> Sync for Ref<T>

§

impl<T> Unpin for Ref<T>
where T: Unpin,

§

impl<T> !UnwindSafe for Ref<T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.