Struct GroupWrapper

pub struct GroupWrapper(pub u32);

wrapper around rapier groups to prevent libraries that use this from needing to import the entirety of rapier.

Tuple Fields

0: u32

Implementations

impl GroupWrapper

pub const GROUP_1: GroupWrapper

The group n°1.

pub const GROUP_2: GroupWrapper

The group n°2.

pub const GROUP_3: GroupWrapper

The group n°3.

pub const GROUP_4: GroupWrapper

The group n°4.

pub const GROUP_5: GroupWrapper

The group n°5.

pub const GROUP_6: GroupWrapper

The group n°6.

pub const GROUP_7: GroupWrapper

The group n°7.

pub const GROUP_8: GroupWrapper

The group n°8.

pub const GROUP_9: GroupWrapper

The group n°9.

pub const GROUP_10: GroupWrapper

The group n°10.

pub const GROUP_11: GroupWrapper

The group n°11.

pub const GROUP_12: GroupWrapper

The group n°12.

pub const GROUP_13: GroupWrapper

The group n°13.

pub const GROUP_14: GroupWrapper

The group n°14.

pub const GROUP_15: GroupWrapper

The group n°15.

pub const GROUP_16: GroupWrapper

The group n°16.

pub const GROUP_17: GroupWrapper

The group n°17.

pub const GROUP_18: GroupWrapper

The group n°18.

pub const GROUP_19: GroupWrapper

The group n°19.

pub const GROUP_20: GroupWrapper

The group n°20.

pub const GROUP_21: GroupWrapper

The group n°21.

pub const GROUP_22: GroupWrapper

The group n°22.

pub const GROUP_23: GroupWrapper

The group n°23.

pub const GROUP_24: GroupWrapper

The group n°24.

pub const GROUP_25: GroupWrapper

The group n°25.

pub const GROUP_26: GroupWrapper

The group n°26.

pub const GROUP_27: GroupWrapper

The group n°27.

pub const GROUP_28: GroupWrapper

The group n°28.

pub const GROUP_29: GroupWrapper

The group n°29.

pub const GROUP_30: GroupWrapper

The group n°30.

pub const GROUP_31: GroupWrapper

The group n°31.

pub const GROUP_32: GroupWrapper

The group n°32.

pub const ALL: GroupWrapper

All of the groups.

pub const NONE: GroupWrapper

None of the groups.

impl GroupWrapper

pub const fn empty() -> GroupWrapper

Get a flags value with all bits unset.

pub const fn all() -> GroupWrapper

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<GroupWrapper>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> GroupWrapper

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> GroupWrapper

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<GroupWrapper>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: GroupWrapper) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: GroupWrapper) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: GroupWrapper)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: GroupWrapper)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: GroupWrapper)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: GroupWrapper, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: GroupWrapper) -> GroupWrapper

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: GroupWrapper) -> GroupWrapper

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: GroupWrapper) -> GroupWrapper

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: GroupWrapper) -> GroupWrapper

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> GroupWrapper

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl GroupWrapper

pub const fn iter(&self) -> Iter<GroupWrapper>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<GroupWrapper>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for GroupWrapper

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

Formats the value using the given formatter.

impl BitAnd for GroupWrapper

fn bitand(self, other: GroupWrapper) -> GroupWrapper

The bitwise and (&) of the bits in two flags values.

type Output = GroupWrapper

The resulting type after applying the & operator.

impl BitAndAssign for GroupWrapper

fn bitand_assign(&mut self, other: GroupWrapper)

The bitwise and (&) of the bits in two flags values.

impl BitOr for GroupWrapper

fn bitor(self, other: GroupWrapper) -> GroupWrapper

The bitwise or (|) of the bits in two flags values.

type Output = GroupWrapper

The resulting type after applying the | operator.

impl BitOrAssign for GroupWrapper

fn bitor_assign(&mut self, other: GroupWrapper)

The bitwise or (|) of the bits in two flags values.

impl BitXor for GroupWrapper

fn bitxor(self, other: GroupWrapper) -> GroupWrapper

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = GroupWrapper

The resulting type after applying the ^ operator.

impl BitXorAssign for GroupWrapper

fn bitxor_assign(&mut self, other: GroupWrapper)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for GroupWrapper

fn clone(&self) -> GroupWrapper

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for GroupWrapper

fn default() -> GroupWrapper

Returns the “default value” for a type.

impl Extend<GroupWrapper> for GroupWrapper

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = GroupWrapper>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for GroupWrapper

const FLAGS: &'static [Flag<GroupWrapper>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> GroupWrapper

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl From<Group> for GroupWrapper

fn from(value: Group) -> GroupWrapper

Converts to this type from the input type.

impl FromIterator<GroupWrapper> for GroupWrapper

fn from_iter<T>(iterator: T) -> GroupWrapper

where T: IntoIterator<Item = GroupWrapper>,

The bitwise or (|) of the bits in each flags value.

impl FromReflect for GroupWrapper

where GroupWrapper: Any + Send + Sync, u32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<GroupWrapper>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for GroupWrapper

where GroupWrapper: Any + Send + Sync, u32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoIterator for GroupWrapper

type Item = GroupWrapper

The type of the elements being iterated over.

type IntoIter = Iter<GroupWrapper>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <GroupWrapper as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for GroupWrapper

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

Formats the value using the given formatter.

impl Not for GroupWrapper

fn not(self) -> GroupWrapper

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = GroupWrapper

The resulting type after applying the ! operator.

impl Octal for GroupWrapper

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

Formats the value using the given formatter.

impl PartialEq for GroupWrapper

fn eq(&self, other: &GroupWrapper) -> 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 PartialReflect for GroupWrapper

where GroupWrapper: Any + Send + Sync, u32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

Clones the value as a Reflect trait object.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<GroupWrapper>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<GroupWrapper>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<GroupWrapper>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for GroupWrapper

where GroupWrapper: Any + Send + Sync, u32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<GroupWrapper>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<GroupWrapper>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Sub for GroupWrapper

fn sub(self, other: GroupWrapper) -> GroupWrapper

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = GroupWrapper

The resulting type after applying the - operator.

impl SubAssign for GroupWrapper

fn sub_assign(&mut self, other: GroupWrapper)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl TupleStruct for GroupWrapper

where GroupWrapper: Any + Send + Sync, u32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl TypePath for GroupWrapper

where GroupWrapper: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for GroupWrapper

where GroupWrapper: Any + Send + Sync, u32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UpperHex for GroupWrapper

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

Formats the value using the given formatter.

impl Copy for GroupWrapper

impl StructuralPartialEq for GroupWrapper