pub struct UserVarFlags { /* private fields */ }
Expand description
Flags of a user variable.
Implementations§
Source§impl UserVarFlags
impl UserVarFlags
pub const UNSIGNED: UserVarFlags
Sourcepub const fn empty() -> UserVarFlags
pub const fn empty() -> UserVarFlags
Returns an empty set of flags.
Sourcepub const fn all() -> UserVarFlags
pub const fn all() -> UserVarFlags
Returns the set containing all flags.
Sourcepub const fn from_bits(bits: u8) -> Option<UserVarFlags>
pub const fn from_bits(bits: u8) -> Option<UserVarFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
Sourcepub const fn from_bits_truncate(bits: u8) -> UserVarFlags
pub const fn from_bits_truncate(bits: u8) -> UserVarFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
Sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> UserVarFlags
pub const unsafe fn from_bits_unchecked(bits: u8) -> UserVarFlags
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: UserVarFlags) -> bool
pub const fn intersects(&self, other: UserVarFlags) -> bool
Returns true
if there are flags common to both self
and other
.
Sourcepub const fn contains(&self, other: UserVarFlags) -> bool
pub const fn contains(&self, other: UserVarFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
Sourcepub fn insert(&mut self, other: UserVarFlags)
pub fn insert(&mut self, other: UserVarFlags)
Inserts the specified flags in-place.
Sourcepub fn remove(&mut self, other: UserVarFlags)
pub fn remove(&mut self, other: UserVarFlags)
Removes the specified flags in-place.
Sourcepub fn toggle(&mut self, other: UserVarFlags)
pub fn toggle(&mut self, other: UserVarFlags)
Toggles the specified flags in-place.
Sourcepub fn set(&mut self, other: UserVarFlags, value: bool)
pub fn set(&mut self, other: UserVarFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
Sourcepub const fn intersection(self, other: UserVarFlags) -> UserVarFlags
pub const fn intersection(self, other: UserVarFlags) -> UserVarFlags
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: UserVarFlags) -> UserVarFlags
pub const fn union(self, other: UserVarFlags) -> UserVarFlags
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: UserVarFlags) -> UserVarFlags
pub const fn difference(self, other: UserVarFlags) -> UserVarFlags
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: UserVarFlags) -> UserVarFlags
pub const fn symmetric_difference(self, other: UserVarFlags) -> UserVarFlags
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) -> UserVarFlags
pub const fn complement(self) -> UserVarFlags
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 UserVarFlags
impl Binary for UserVarFlags
Source§impl BitAnd for UserVarFlags
impl BitAnd for UserVarFlags
Source§fn bitand(self, other: UserVarFlags) -> UserVarFlags
fn bitand(self, other: UserVarFlags) -> UserVarFlags
Returns the intersection between the two sets of flags.
Source§type Output = UserVarFlags
type Output = UserVarFlags
&
operator.Source§impl BitAndAssign for UserVarFlags
impl BitAndAssign for UserVarFlags
Source§fn bitand_assign(&mut self, other: UserVarFlags)
fn bitand_assign(&mut self, other: UserVarFlags)
Disables all flags disabled in the set.
Source§impl BitOr for UserVarFlags
impl BitOr for UserVarFlags
Source§fn bitor(self, other: UserVarFlags) -> UserVarFlags
fn bitor(self, other: UserVarFlags) -> UserVarFlags
Returns the union of the two sets of flags.
Source§type Output = UserVarFlags
type Output = UserVarFlags
|
operator.Source§impl BitOrAssign for UserVarFlags
impl BitOrAssign for UserVarFlags
Source§fn bitor_assign(&mut self, other: UserVarFlags)
fn bitor_assign(&mut self, other: UserVarFlags)
Adds the set of flags.
Source§impl BitXor for UserVarFlags
impl BitXor for UserVarFlags
Source§fn bitxor(self, other: UserVarFlags) -> UserVarFlags
fn bitxor(self, other: UserVarFlags) -> UserVarFlags
Returns the left flags, but with all the right flags toggled.
Source§type Output = UserVarFlags
type Output = UserVarFlags
^
operator.Source§impl BitXorAssign for UserVarFlags
impl BitXorAssign for UserVarFlags
Source§fn bitxor_assign(&mut self, other: UserVarFlags)
fn bitxor_assign(&mut self, other: UserVarFlags)
Toggles the set of flags.
Source§impl Bitflags for UserVarFlags
impl Bitflags for UserVarFlags
type Repr = u8
fn empty() -> UserVarFlags
fn all() -> UserVarFlags
fn bits(&self) -> <UserVarFlags as Bitflags>::Repr
fn from_bits(bits: <UserVarFlags as Bitflags>::Repr) -> Option<UserVarFlags>
fn from_bits_truncate(bits: <UserVarFlags as Bitflags>::Repr) -> UserVarFlags
Source§unsafe fn from_bits_unchecked(
bits: <UserVarFlags as Bitflags>::Repr,
) -> UserVarFlags
unsafe fn from_bits_unchecked( bits: <UserVarFlags as Bitflags>::Repr, ) -> UserVarFlags
fn is_empty(&self) -> bool
fn is_all(&self) -> bool
fn intersects(&self, other: UserVarFlags) -> bool
fn contains(&self, other: UserVarFlags) -> bool
fn insert(&mut self, other: UserVarFlags)
fn remove(&mut self, other: UserVarFlags)
fn toggle(&mut self, other: UserVarFlags)
fn set(&mut self, other: UserVarFlags, value: bool)
Source§impl Clone for UserVarFlags
impl Clone for UserVarFlags
Source§fn clone(&self) -> UserVarFlags
fn clone(&self) -> UserVarFlags
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for UserVarFlags
impl Debug for UserVarFlags
Source§impl Default for UserVarFlags
impl Default for UserVarFlags
Source§fn default() -> UserVarFlags
fn default() -> UserVarFlags
Source§impl Extend<UserVarFlags> for UserVarFlags
impl Extend<UserVarFlags> for UserVarFlags
Source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = UserVarFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = UserVarFlags>,
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<UserVarFlags> for UserVarFlags
impl FromIterator<UserVarFlags> for UserVarFlags
Source§fn from_iter<T>(iterator: T) -> UserVarFlagswhere
T: IntoIterator<Item = UserVarFlags>,
fn from_iter<T>(iterator: T) -> UserVarFlagswhere
T: IntoIterator<Item = UserVarFlags>,
Source§impl Hash for UserVarFlags
impl Hash for UserVarFlags
Source§impl LowerHex for UserVarFlags
impl LowerHex for UserVarFlags
Source§impl Not for UserVarFlags
impl Not for UserVarFlags
Source§fn not(self) -> UserVarFlags
fn not(self) -> UserVarFlags
Returns the complement of this set of flags.
Source§type Output = UserVarFlags
type Output = UserVarFlags
!
operator.Source§impl Octal for UserVarFlags
impl Octal for UserVarFlags
Source§impl Ord for UserVarFlags
impl Ord for UserVarFlags
Source§fn cmp(&self, other: &UserVarFlags) -> Ordering
fn cmp(&self, other: &UserVarFlags) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialEq for UserVarFlags
impl PartialEq for UserVarFlags
Source§impl PartialOrd for UserVarFlags
impl PartialOrd for UserVarFlags
Source§impl Sub for UserVarFlags
impl Sub for UserVarFlags
Source§fn sub(self, other: UserVarFlags) -> UserVarFlags
fn sub(self, other: UserVarFlags) -> UserVarFlags
Returns the set difference of the two sets of flags.
Source§type Output = UserVarFlags
type Output = UserVarFlags
-
operator.Source§impl SubAssign for UserVarFlags
impl SubAssign for UserVarFlags
Source§fn sub_assign(&mut self, other: UserVarFlags)
fn sub_assign(&mut self, other: UserVarFlags)
Disables all flags enabled in the set.
Source§impl TryFrom<u8> for UserVarFlags
impl TryFrom<u8> for UserVarFlags
Source§type Error = UnknownUserVarFlags
type Error = UnknownUserVarFlags
Source§fn try_from(val: u8) -> Result<UserVarFlags, UnknownUserVarFlags>
fn try_from(val: u8) -> Result<UserVarFlags, UnknownUserVarFlags>
Source§impl UpperHex for UserVarFlags
impl UpperHex for UserVarFlags
impl Copy for UserVarFlags
impl Eq for UserVarFlags
impl StructuralPartialEq for UserVarFlags
Auto Trait Implementations§
impl Freeze for UserVarFlags
impl RefUnwindSafe for UserVarFlags
impl Send for UserVarFlags
impl Sync for UserVarFlags
impl Unpin for UserVarFlags
impl UnwindSafe for UserVarFlags
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CallHasher for T
impl<T> CallHasher for T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Choices> CoproductSubsetter<CNil, HNil> for Choices
impl<Choices> CoproductSubsetter<CNil, HNil> for Choices
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.