Struct physx::foundation::ErrorCodes
source · #[repr(transparent)]pub struct ErrorCodes { /* private fields */ }
Implementations§
source§impl ErrorCodes
impl ErrorCodes
sourcepub const DebugWarning: Self = _
pub const DebugWarning: Self = _
A warning message for the user to help with debugging
sourcepub const InvalidParameter: Self = _
pub const InvalidParameter: Self = _
Method called with invalid parameter(s)
sourcepub const InvalidOperation: Self = _
pub const InvalidOperation: Self = _
Method was called at a time when an operation is not possible
sourcepub const OutOfMemory: Self = _
pub const OutOfMemory: Self = _
Method failed to allocate some memory
sourcepub const InternalError: Self = _
pub const InternalError: Self = _
The library failed for some reason.
Possibly you have passed invalid values like NaNs, which are not checked for.
sourcepub const Abort: Self = _
pub const Abort: Self = _
An unrecoverable error, execution should be halted and log output flushed
sourcepub const PerfWarning: Self = _
pub const PerfWarning: Self = _
The SDK has determined that an operation may result in poor performance.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl Binary for ErrorCodes
impl Binary for ErrorCodes
source§impl BitAnd<ErrorCodes> for ErrorCodes
impl BitAnd<ErrorCodes> for ErrorCodes
source§impl BitAndAssign<ErrorCodes> for ErrorCodes
impl BitAndAssign<ErrorCodes> for ErrorCodes
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<ErrorCodes> for ErrorCodes
impl BitOr<ErrorCodes> for ErrorCodes
source§fn bitor(self, other: ErrorCodes) -> Self
fn bitor(self, other: ErrorCodes) -> Self
Returns the union of the two sets of flags.
§type Output = ErrorCodes
type Output = ErrorCodes
|
operator.source§impl BitOrAssign<ErrorCodes> for ErrorCodes
impl BitOrAssign<ErrorCodes> for ErrorCodes
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<ErrorCodes> for ErrorCodes
impl BitXor<ErrorCodes> for ErrorCodes
source§impl BitXorAssign<ErrorCodes> for ErrorCodes
impl BitXorAssign<ErrorCodes> for ErrorCodes
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ErrorCodes
impl Clone for ErrorCodes
source§fn clone(&self) -> ErrorCodes
fn clone(&self) -> ErrorCodes
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ErrorCodes
impl Debug for ErrorCodes
source§impl Extend<ErrorCodes> for ErrorCodes
impl Extend<ErrorCodes> for ErrorCodes
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<ErrorCodes> for ErrorCodes
impl FromIterator<ErrorCodes> for ErrorCodes
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for ErrorCodes
impl Hash for ErrorCodes
source§impl LowerHex for ErrorCodes
impl LowerHex for ErrorCodes
source§impl Not for ErrorCodes
impl Not for ErrorCodes
source§impl Octal for ErrorCodes
impl Octal for ErrorCodes
source§impl Ord for ErrorCodes
impl Ord for ErrorCodes
source§fn cmp(&self, other: &ErrorCodes) -> Ordering
fn cmp(&self, other: &ErrorCodes) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<ErrorCodes> for ErrorCodes
impl PartialEq<ErrorCodes> for ErrorCodes
source§fn eq(&self, other: &ErrorCodes) -> bool
fn eq(&self, other: &ErrorCodes) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ErrorCodes> for ErrorCodes
impl PartialOrd<ErrorCodes> for ErrorCodes
source§fn partial_cmp(&self, other: &ErrorCodes) -> Option<Ordering>
fn partial_cmp(&self, other: &ErrorCodes) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<ErrorCodes> for ErrorCodes
impl Sub<ErrorCodes> for ErrorCodes
source§impl SubAssign<ErrorCodes> for ErrorCodes
impl SubAssign<ErrorCodes> for ErrorCodes
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.