Enum ScopeSummary 

pub(crate) enum ScopeSummary {
    Empty,
    Uniform(Entity),
    Mixed,
}

Which scopes an archetype’s rows live in, as far as a whole-archetype gate can tell.

A derived summary, not part of the archetype’s identity: it is counted from the scope each row was pushed with, and the gates below are the only thing that uses it. Both gates are conservative in the same direction: they never accept a row that the per-row check would reject.

Variants

Empty

No rows.

Uniform(Entity)

Every row lives in this scope.

Mixed

Rows live in more than one scope.

Implementations

impl ScopeSummary

pub(crate) fn any_visible(self, world: &World, caller: Entity) -> bool

Whether at least one row of the archetype is visible from caller.

This is the gate a query applies before it visits any row. A uniform archetype is either entirely visible or has exactly one visible row: the caller’s own entity, which lives in caller’s parent scope and so sits in that parent’s uniform archetype.

pub(crate) fn all_visible(self, world: &World, caller: Entity) -> bool

Whether every row of the archetype is visible from caller.

Vacuously true for an empty archetype, which is why the callers that hand out rows also require the archetype to be non-empty.

pub(crate) fn row_visible( self, archetype: &Archetype, world: &World, caller: Entity, row: usize, ) -> bool

Whether row row of archetype is visible from caller.

The per-row answer for a summary a whole-archetype gate could not decide. The caller’s own row is always visible: a scope sees the entity it is rooted at, and that entity lives in the scope’s parent.

Trait Implementations

impl Clone for ScopeSummary

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ScopeSummary

impl Debug for ScopeSummary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScopeSummary

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ScopeSummary

impl PartialEq for ScopeSummary

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ScopeSummary