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

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

Expand description

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

Implementations

[src]

impl<'a> EntryRef<'a>

[src]

pub fn archetype(&self) -> &Archetype

Returns the entity’s archetype.

[src]

pub fn location(&self) -> EntityLocation

Returns the entity’s location.

[src]

pub fn into_component<T: Component>(self) -> Result<&'a T, ComponentError>

Returns a reference to one of the entity’s components.

[src]

pub unsafe fn into_component_unchecked<T: Component>(
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.

[src]

pub fn get_component<T: Component>(&self) -> Result<&T, ComponentError>

Returns a reference to one of the entity’s components.

[src]

pub unsafe fn get_component_unchecked<T: Component>(
&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.

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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> Downcast for T where
T: Any,

[src]

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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. Read more

[src]

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

[src]

pub 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. Read more

[src]

pub 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. Read more

[src]

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

[src]

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

Implementations

impl<'a> EntryRef<'a>

pub fn archetype(&self) -> &Archetype

pub fn location(&self) -> EntityLocation

pub fn into_component<T: Component>(self) -> Result<&'a T, ComponentError>

pub unsafe fn into_component_unchecked<T: Component>( self) -> Result<&'a mut T, ComponentError>

Safety

pub fn get_component<T: Component>(&self) -> Result<&T, ComponentError>

pub unsafe fn get_component_unchecked<T: Component>( &self) -> Result<&mut T, ComponentError>

Safety

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,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

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

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

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

pub unsafe fn into_component_unchecked<T: Component>(
self
) -> Result<&'a mut T, ComponentError>

pub unsafe fn get_component_unchecked<T: Component>(
&self
) -> Result<&mut T, ComponentError>

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

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

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

impl<T> Downcast for T where
T: Any,

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

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

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

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