Struct legion::world::EntryRef[][src]

pub struct EntryRef<'a> { /* fields omitted */ }

Provides safe read-only access to an entity’s components.

Implementations

impl<'a> EntryRef<'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 unsafe fn into_component_unchecked<T: Component>(
    self
) -> Result<&'a mut T, ComponentError>
[src]

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 unsafe fn get_component_unchecked<T: Component>(
    &self
) -> Result<&mut T, ComponentError>
[src]

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.

Auto Trait Implementations

impl<'a> !RefUnwindSafe for EntryRef<'a>

impl<'a> Send for EntryRef<'a>

impl<'a> Sync for EntryRef<'a>

impl<'a> Unpin for EntryRef<'a>

impl<'a> !UnwindSafe for EntryRef<'a>

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> Downcast for T where
    T: Any
[src]

impl<T> DowncastSync for T where
    T: Send + Sync + Any
[src]

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

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

impl<T> Pointable for T

type Init = T

The type for initializers.

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.