#[repr(C)]pub struct TypeFlags { /* private fields */ }
Implementations
sourceimpl TypeFlags
impl TypeFlags
pub const HAS_CHILDREN: TypeFlags = Self{ bits: 1,}
pub const HAS_VALUE: TypeFlags = Self{ bits: 2,}
pub const IS_ARRAY: TypeFlags = Self{ bits: 4,}
pub const IS_BLOCK: TypeFlags = Self{ bits: 8,}
pub const IS_BUILTIN: TypeFlags = Self{ bits: 16,}
pub const IS_CLASS: TypeFlags = Self{ bits: 32,}
pub const IS_CPLUSPLUS: TypeFlags = Self{ bits: 64,}
pub const IS_ENUMERATION: TypeFlags = Self{ bits: 128,}
pub const IS_FUNC_PROTOTYPE: TypeFlags = Self{ bits: 256,}
pub const IS_MEMBER: TypeFlags = Self{ bits: 512,}
pub const IS_OBJC: TypeFlags = Self{ bits: 1024,}
pub const IS_POINTER: TypeFlags = Self{ bits: 2048,}
pub const IS_REFERENCE: TypeFlags = Self{ bits: 4096,}
pub const IS_STRUCT_UNION: TypeFlags = Self{ bits: 8192,}
pub const IS_TEMPLATE: TypeFlags = Self{ bits: 16384,}
pub const IS_TYPEDEF: TypeFlags = Self{ bits: 32768,}
pub const IS_VECTOR: TypeFlags = Self{ bits: 65536,}
pub const IS_SCALAR: TypeFlags = Self{ bits: 131072,}
pub const IS_INTEGER: TypeFlags = Self{ bits: 262144,}
pub const IS_FLOAT: TypeFlags = Self{ bits: 524288,}
pub const IS_COMPLEX: TypeFlags = Self{ bits: 1048576,}
pub const IS_SIGNED: TypeFlags = Self{ bits: 2097152,}
pub const INSTANCE_IS_POINTER: TypeFlags = Self{ bits: 4194304,}
sourcepub const fn from_bits(bits: u32) -> Option<TypeFlags>
pub const fn from_bits(bits: u32) -> Option<TypeFlags>
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) -> TypeFlags
pub const fn from_bits_truncate(bits: u32) -> TypeFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> TypeFlags
pub const unsafe fn from_bits_unchecked(bits: u32) -> TypeFlags
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: TypeFlags) -> bool
pub const fn intersects(&self, other: TypeFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: TypeFlags) -> bool
pub const fn contains(&self, other: TypeFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: TypeFlags, value: bool)
pub fn set(&mut self, other: TypeFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: TypeFlags) -> TypeFlags
pub const fn intersection(self, other: TypeFlags) -> TypeFlags
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: TypeFlags) -> TypeFlags
pub const fn union(self, other: TypeFlags) -> TypeFlags
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: TypeFlags) -> TypeFlags
pub const fn difference(self, other: TypeFlags) -> TypeFlags
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: TypeFlags) -> TypeFlags
pub const fn symmetric_difference(self, other: TypeFlags) -> TypeFlags
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) -> TypeFlags
pub const fn complement(self) -> TypeFlags
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
sourceimpl BitAndAssign<TypeFlags> for TypeFlags
impl BitAndAssign<TypeFlags> for TypeFlags
sourcefn bitand_assign(&mut self, other: TypeFlags)
fn bitand_assign(&mut self, other: TypeFlags)
Disables all flags disabled in the set.
sourceimpl BitOrAssign<TypeFlags> for TypeFlags
impl BitOrAssign<TypeFlags> for TypeFlags
sourcefn bitor_assign(&mut self, other: TypeFlags)
fn bitor_assign(&mut self, other: TypeFlags)
Adds the set of flags.
sourceimpl BitXorAssign<TypeFlags> for TypeFlags
impl BitXorAssign<TypeFlags> for TypeFlags
sourcefn bitxor_assign(&mut self, other: TypeFlags)
fn bitxor_assign(&mut self, other: TypeFlags)
Toggles the set of flags.
sourceimpl Extend<TypeFlags> for TypeFlags
impl Extend<TypeFlags> for TypeFlags
sourcefn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = TypeFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = TypeFlags>,
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<TypeFlags> for TypeFlags
impl FromIterator<TypeFlags> for TypeFlags
sourceimpl Ord for TypeFlags
impl Ord for TypeFlags
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialOrd<TypeFlags> for TypeFlags
impl PartialOrd<TypeFlags> for TypeFlags
sourcefn partial_cmp(&self, other: &TypeFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &TypeFlags) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl SubAssign<TypeFlags> for TypeFlags
impl SubAssign<TypeFlags> for TypeFlags
sourcefn sub_assign(&mut self, other: TypeFlags)
fn sub_assign(&mut self, other: TypeFlags)
Disables all flags enabled in the set.