pub struct AppWorldWrapper<W: AppWorld> { /* private fields */ }
Expand description

Holds application state and resources. See the crate level documentation for more details.

Cloning

Cloning an AppWorldWrapper is a very cheap operation.

All clones hold pointers to the same inner state.

Implementations§

source§

impl<W: AppWorld + 'static> AppWorldWrapper<W>

source

pub fn new(world: W) -> Self

Create a new AppWorldWrapper.

source

pub fn msg(&self, msg: W::Message)

Acquire write access to the AppWorld then send a message.

source§

impl<W: AppWorld + 'static> AppWorldWrapper<W>

source

pub fn read(&self) -> WorldReadGuard<'_, W>

Acquire read access to AppWorld.

Panics

Panics if the current thread is already holding a read guard.

This panic prevents the following scenario from deadlocking:

  1. Thread A acquires a read guard
  2. Thread B calls AppWorld::msg, which attempts to acquire a write lock
  3. Thread A attempts to acquire a second read guard while the first is still active

Trait Implementations§

source§

impl<W: AppWorld> Clone for AppWorldWrapper<W>

source§

fn clone(&self) -> Self

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<W> RefUnwindSafe for AppWorldWrapper<W>

§

impl<W> Send for AppWorldWrapper<W>where W: Send + Sync,

§

impl<W> Sync for AppWorldWrapper<W>where W: Send + Sync,

§

impl<W> Unpin for AppWorldWrapper<W>

§

impl<W> UnwindSafe for AppWorldWrapper<W>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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.