Struct InteractionGroups

#[repr(C)]
pub struct InteractionGroups {
    pub memberships: Group,
    pub filter: Group,
}

Pairwise filtering using bit masks.

This filtering method is based on two 32-bit values:

• The interaction groups memberships.
• The interaction groups filter.

An interaction is allowed between two filters a and b when two conditions are met simultaneously:

• The groups membership of a has at least one bit set to 1 in common with the groups filter of b.
• The groups membership of b has at least one bit set to 1 in common with the groups filter of a.

In other words, interactions are allowed between two filter iff. the following condition is met:

(self.memberships & rhs.filter) != 0 && (rhs.memberships & self.filter) != 0

Fields

memberships: Group

Groups memberships.

filter: Group

Groups filter.

Implementations

impl InteractionGroups

pub const fn new(memberships: Group, filter: Group) -> Self

Initializes with the given interaction groups and interaction mask.

pub const fn all() -> Self

Allow interaction with everything.

pub const fn none() -> Self

Prevent all interactions.

pub const fn with_memberships(self, memberships: Group) -> Self

Sets the group this filter is part of.

pub const fn with_filter(self, filter: Group) -> Self

Sets the interaction mask of this filter.

pub const fn test(self, rhs: Self) -> bool

Check if interactions should be allowed based on the interaction memberships and filter.

An interaction is allowed iff. the memberships of self contain at least one bit set to 1 in common with the filter of rhs, and vice-versa.

Trait Implementations

impl Clone for InteractionGroups

fn clone(&self) -> InteractionGroups

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InteractionGroups

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

Formats the value using the given formatter.

impl Default for InteractionGroups

fn default() -> Self

Returns the “default value” for a type.

impl From<InteractionGroups> for QueryFilter<'_>

fn from(groups: InteractionGroups) -> Self

Converts to this type from the input type.

impl Hash for InteractionGroups

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for InteractionGroups

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for InteractionGroups

impl Eq for InteractionGroups

impl StructuralPartialEq for InteractionGroups