Struct glib::OptionFlags
source · [−]pub struct OptionFlags { /* private fields */ }Implementations
sourceimpl OptionFlags
impl OptionFlags
pub const NONE: Self = _
pub const HIDDEN: Self = _
pub const IN_MAIN: Self = _
pub const REVERSE: Self = _
pub const NO_ARG: Self = _
pub const FILENAME: Self = _
pub const OPTIONAL_ARG: Self = _
pub const NOALIAS: Self = _
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
sourceimpl Binary for OptionFlags
impl Binary for OptionFlags
sourceimpl BitAnd<OptionFlags> for OptionFlags
impl BitAnd<OptionFlags> for OptionFlags
type Output = OptionFlags
type Output = OptionFlags
& operator.sourceimpl BitAndAssign<OptionFlags> for OptionFlags
impl BitAndAssign<OptionFlags> for OptionFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<OptionFlags> for OptionFlags
impl BitOr<OptionFlags> for OptionFlags
sourcefn bitor(self, other: OptionFlags) -> Self
fn bitor(self, other: OptionFlags) -> Self
Returns the union of the two sets of flags.
type Output = OptionFlags
type Output = OptionFlags
| operator.sourceimpl BitOrAssign<OptionFlags> for OptionFlags
impl BitOrAssign<OptionFlags> for OptionFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<OptionFlags> for OptionFlags
impl BitXor<OptionFlags> for OptionFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = OptionFlags
type Output = OptionFlags
^ operator.sourceimpl BitXorAssign<OptionFlags> for OptionFlags
impl BitXorAssign<OptionFlags> for OptionFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for OptionFlags
impl Clone for OptionFlags
sourcefn clone(&self) -> OptionFlags
fn clone(&self) -> OptionFlags
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moresourceimpl Debug for OptionFlags
impl Debug for OptionFlags
sourceimpl Display for OptionFlags
impl Display for OptionFlags
sourceimpl Extend<OptionFlags> for OptionFlags
impl Extend<OptionFlags> for OptionFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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<OptionFlags> for OptionFlags
impl FromIterator<OptionFlags> for OptionFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl Hash for OptionFlags
impl Hash for OptionFlags
sourceimpl LowerHex for OptionFlags
impl LowerHex for OptionFlags
sourceimpl Not for OptionFlags
impl Not for OptionFlags
type Output = OptionFlags
type Output = OptionFlags
! operator.sourceimpl Octal for OptionFlags
impl Octal for OptionFlags
sourceimpl Ord for OptionFlags
impl Ord for OptionFlags
sourcefn cmp(&self, other: &OptionFlags) -> Ordering
fn cmp(&self, other: &OptionFlags) -> Ordering
1.21.0 · sourceconst fn max(self, other: Self) -> Self
const fn max(self, other: Self) -> Self
1.21.0 · sourceconst fn min(self, other: Self) -> Self
const fn min(self, other: Self) -> Self
1.50.0 · sourceconst fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
const fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialEq<OptionFlags> for OptionFlags
impl PartialEq<OptionFlags> for OptionFlags
sourcefn eq(&self, other: &OptionFlags) -> bool
fn eq(&self, other: &OptionFlags) -> bool
sourceimpl PartialOrd<OptionFlags> for OptionFlags
impl PartialOrd<OptionFlags> for OptionFlags
sourcefn partial_cmp(&self, other: &OptionFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &OptionFlags) -> Option<Ordering>
1.0.0 · sourceconst fn le(&self, other: &Rhs) -> bool
const fn le(&self, other: &Rhs) -> bool
self and other) and is used by the <=
operator. Read moresourceimpl Sub<OptionFlags> for OptionFlags
impl Sub<OptionFlags> for OptionFlags
type Output = OptionFlags
type Output = OptionFlags
- operator.sourceimpl SubAssign<OptionFlags> for OptionFlags
impl SubAssign<OptionFlags> for OptionFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.