Struct legion::world::Entry [−][src]
Provides safe read and write access to an entity’s components, and the ability to modify the entity.
Implementations
impl<'a> Entry<'a>
[src]
pub fn archetype(&self) -> &Archetype
[src]
Returns the entity’s archetype.
pub fn location(&self) -> EntityLocation
[src]
Returns the entity’s location.
pub fn into_component<T: Component>(self) -> Result<&'a T, ComponentError>
[src]
Returns a reference to one of the entity’s components.
pub fn into_component_mut<T: Component>(
self
) -> Result<&'a mut T, ComponentError>
[src]
self
) -> Result<&'a mut T, ComponentError>
Returns a mutable reference to one of the entity’s components.
pub unsafe fn into_component_unchecked<T: Component>(
self
) -> Result<&'a mut T, ComponentError>
[src]
self
) -> Result<&'a mut T, ComponentError>
Returns a mutable reference to one of the entity’s components.
Safety
This function bypasses static borrow checking. The caller must ensure that the component reference will not be mutably aliased.
pub fn get_component<T: Component>(&self) -> Result<&T, ComponentError>
[src]
Returns a reference to one of the entity’s components.
pub fn get_component_mut<T: Component>(
&mut self
) -> Result<&mut T, ComponentError>
[src]
&mut self
) -> Result<&mut T, ComponentError>
Returns a mutable reference to one of the entity’s components.
pub unsafe fn get_component_unchecked<T: Component>(
&self
) -> Result<&mut T, ComponentError>
[src]
&self
) -> Result<&mut T, ComponentError>
Returns a mutable reference to one of the entity’s components.
Safety
This function bypasses static borrow checking. The caller must ensure that the component reference will not be mutably aliased.
pub fn add_component<T: Component>(&mut self, component: T)
[src]
Adds a new component to the entity. If the component already exists, its value will be replaced.
pub fn remove_component<T: Component>(&mut self)
[src]
Removes a component from the entity. Does nothing if the entity does not have the component.
Auto Trait Implementations
impl<'a> !RefUnwindSafe for Entry<'a>
impl<'a> Send for Entry<'a>
impl<'a> Sync for Entry<'a>
impl<'a> Unpin for Entry<'a>
impl<'a> !UnwindSafe for Entry<'a>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Downcast for T where
T: Any,
[src]
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
[src]
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
[src]
pub fn as_any(&self) -> &(dyn Any + 'static)
[src]
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
[src]
impl<T> DowncastSync for T where
T: Send + Sync + Any,
[src]
T: Send + Sync + Any,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,