Struct bevy_ecs::world::WorldCell

source ·
pub struct WorldCell<'w> { /* private fields */ }
Expand description

Exposes safe mutable access to multiple resources at a time in a World. Attempting to access World in a way that violates Rust’s mutability rules will panic thanks to runtime checks.

Implementations§

source§

impl<'w> WorldCell<'w>

source

pub fn get_resource<T: Resource>(&self) -> Option<WorldBorrow<'_, T>>

Gets a reference to the resource of the given type

source

pub fn resource<T: Resource>(&self) -> WorldBorrow<'_, T>

Gets a reference to the resource of the given type

Panics

Panics if the resource does not exist. Use get_resource instead if you want to handle this case.

source

pub fn get_resource_mut<T: Resource>(&self) -> Option<WorldBorrowMut<'_, T>>

Gets a mutable reference to the resource of the given type

source

pub fn resource_mut<T: Resource>(&self) -> WorldBorrowMut<'_, T>

Gets a mutable reference to the resource of the given type

Panics

Panics if the resource does not exist. Use get_resource_mut instead if you want to handle this case.

source

pub fn get_non_send_resource<T: 'static>(&self) -> Option<WorldBorrow<'_, T>>

Gets an immutable reference to the non-send resource of the given type, if it exists.

source

pub fn non_send_resource<T: 'static>(&self) -> WorldBorrow<'_, T>

Gets an immutable reference to the non-send resource of the given type, if it exists.

Panics

Panics if the resource does not exist. Use get_non_send_resource instead if you want to handle this case.

source

pub fn get_non_send_resource_mut<T: 'static>( &self ) -> Option<WorldBorrowMut<'_, T>>

Gets a mutable reference to the non-send resource of the given type, if it exists.

source

pub fn non_send_resource_mut<T: 'static>(&self) -> WorldBorrowMut<'_, T>

Gets a mutable reference to the non-send resource of the given type, if it exists.

Panics

Panics if the resource does not exist. Use get_non_send_resource_mut instead if you want to handle this case.

source

pub fn send_event<E: Event>(&self, event: E)

Sends an Event.

source

pub fn send_event_default<E: Event + Default>(&self)

Sends the default value of the Event of type E.

source

pub fn send_event_batch<E: Event>(&self, events: impl Iterator<Item = E>)

Sends a batch of Events from an iterator.

Trait Implementations§

source§

impl<'w> Drop for WorldCell<'w>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'w> !RefUnwindSafe for WorldCell<'w>

§

impl<'w> !Send for WorldCell<'w>

§

impl<'w> !Sync for WorldCell<'w>

§

impl<'w> Unpin for WorldCell<'w>

§

impl<'w> !UnwindSafe for WorldCell<'w>

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> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more