Struct hecs::View

source ·
pub struct View<'q, Q: Query> { /* private fields */ }
Expand description

Provides random access to the results of a query

Implementations§

source§

impl<'q, Q: Query> View<'q, Q>

source

pub fn get(&self, entity: Entity) -> Option<Q::Item<'_>>
where Q: QueryShared,

Retrieve the query results corresponding to entity

Will yield None if the entity does not exist or does not match the query.

Does not require exclusive access to the map, but is defined only for queries yielding only shared references.

source

pub fn get_mut(&mut self, entity: Entity) -> Option<Q::Item<'_>>

Retrieve the query results corresponding to entity

Will yield None if the entity does not exist or does not match the query.

source

pub fn contains(&self, entity: Entity) -> bool

Equivalent to get(entity).is_some(), but does not require Q: QueryShared

source

pub unsafe fn get_unchecked(&self, entity: Entity) -> Option<Q::Item<'_>>

Like get_mut, but allows simultaneous access to multiple entities

Safety

Must not be invoked while any unique borrow of the fetched components of entity is live.

source

pub fn get_mut_n<const N: usize>( &mut self, entities: [Entity; N] ) -> [Option<Q::Item<'_>>; N]

Like get_mut, but allows checked simultaneous access to multiple entities

For N > 3, the check for distinct entities will clone the array and take O(N log N) time.

Examples
let mut world = World::new();

let a = world.spawn((1, 1.0));
let b = world.spawn((2, 4.0));
let c = world.spawn((3, 9.0));

let mut query = world.query_mut::<&mut i32>();
let mut view = query.view();
let [a,b,c] = view.get_mut_n([a, b, c]);

assert_eq!(*a.unwrap(), 1);
assert_eq!(*b.unwrap(), 2);
assert_eq!(*c.unwrap(), 3);
source

pub fn iter_mut(&mut self) -> ViewIter<'_, Q>

Iterate over all entities satisfying Q

Equivalent to QueryBorrow::iter.

Trait Implementations§

source§

impl<'a, 'q, Q: Query> IntoIterator for &'a mut View<'q, Q>

§

type IntoIter = ViewIter<'a, Q>

Which kind of iterator are we turning this into?
§

type Item = (Entity, <Q as Query>::Item<'a>)

The type of the elements being iterated over.
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'q, Q: Query> Send for View<'q, Q>
where for<'a> Q::Item<'a>: Send,

source§

impl<'q, Q: Query> Sync for View<'q, Q>
where for<'a> Q::Item<'a>: Send,

Auto Trait Implementations§

§

impl<'q, Q> RefUnwindSafe for View<'q, Q>
where <Q as Query>::Fetch: RefUnwindSafe,

§

impl<'q, Q> Unpin for View<'q, Q>
where <Q as Query>::Fetch: Unpin,

§

impl<'q, Q> UnwindSafe for View<'q, Q>
where <Q as Query>::Fetch: UnwindSafe,

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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.