pub struct ParamFlags { /* private fields */ }
Implementations§
§impl ParamFlags
impl ParamFlags
pub const READABLE: ParamFlags = Self{ bits: gobject_ffi::G_PARAM_READABLE as _,}
pub const WRITABLE: ParamFlags = Self{ bits: gobject_ffi::G_PARAM_WRITABLE as _,}
pub const READWRITE: ParamFlags = Self{ bits: gobject_ffi::G_PARAM_READWRITE as _,}
pub const CONSTRUCT: ParamFlags = Self{ bits: gobject_ffi::G_PARAM_CONSTRUCT as _,}
pub const CONSTRUCT_ONLY: ParamFlags = Self{ bits: gobject_ffi::G_PARAM_CONSTRUCT_ONLY as _,}
pub const LAX_VALIDATION: ParamFlags = Self{ bits: gobject_ffi::G_PARAM_LAX_VALIDATION as _,}
pub const USER_1: ParamFlags = Self{ bits: 256,}
pub const USER_2: ParamFlags = Self{ bits: 1024,}
pub const USER_3: ParamFlags = Self{ bits: 2048,}
pub const USER_4: ParamFlags = Self{ bits: 4096,}
pub const USER_5: ParamFlags = Self{ bits: 8192,}
pub const USER_6: ParamFlags = Self{ bits: 16384,}
pub const USER_7: ParamFlags = Self{ bits: 32768,}
pub const USER_8: ParamFlags = Self{ bits: 65536,}
pub const EXPLICIT_NOTIFY: ParamFlags = Self{ bits: gobject_ffi::G_PARAM_EXPLICIT_NOTIFY as _,}
pub const DEPRECATED: ParamFlags = Self{ bits: gobject_ffi::G_PARAM_DEPRECATED as _,}
pub const fn empty() -> ParamFlags
pub const fn empty() -> ParamFlags
Returns an empty set of flags.
pub const fn all() -> ParamFlags
pub const fn all() -> ParamFlags
Returns the set containing all flags.
pub const fn from_bits(bits: u32) -> Option<ParamFlags>
pub const fn from_bits(bits: u32) -> Option<ParamFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: u32) -> ParamFlags
pub const fn from_bits_truncate(bits: u32) -> ParamFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u32) -> ParamFlags
pub const unsafe fn from_bits_unchecked(bits: u32) -> ParamFlags
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.
pub const fn intersects(&self, other: ParamFlags) -> bool
pub const fn intersects(&self, other: ParamFlags) -> bool
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: ParamFlags) -> bool
pub const fn contains(&self, other: ParamFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: ParamFlags)
pub fn insert(&mut self, other: ParamFlags)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: ParamFlags)
pub fn remove(&mut self, other: ParamFlags)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: ParamFlags)
pub fn toggle(&mut self, other: ParamFlags)
Toggles the specified flags in-place.
pub fn set(&mut self, other: ParamFlags, value: bool)
pub fn set(&mut self, other: ParamFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
pub const fn intersection(self, other: ParamFlags) -> ParamFlags
pub const fn intersection(self, other: ParamFlags) -> ParamFlags
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
.
pub const fn union(self, other: ParamFlags) -> ParamFlags
pub const fn union(self, other: ParamFlags) -> ParamFlags
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
.
pub const fn difference(self, other: ParamFlags) -> ParamFlags
pub const fn difference(self, other: ParamFlags) -> ParamFlags
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
.
pub const fn symmetric_difference(self, other: ParamFlags) -> ParamFlags
pub const fn symmetric_difference(self, other: ParamFlags) -> ParamFlags
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
.
pub const fn complement(self) -> ParamFlags
pub const fn complement(self) -> ParamFlags
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§
§impl Binary for ParamFlags
impl Binary for ParamFlags
§impl BitAnd<ParamFlags> for ParamFlags
impl BitAnd<ParamFlags> for ParamFlags
§fn bitand(self, other: ParamFlags) -> ParamFlags
fn bitand(self, other: ParamFlags) -> ParamFlags
Returns the intersection between the two sets of flags.
§type Output = ParamFlags
type Output = ParamFlags
&
operator.§impl BitAndAssign<ParamFlags> for ParamFlags
impl BitAndAssign<ParamFlags> for ParamFlags
§fn bitand_assign(&mut self, other: ParamFlags)
fn bitand_assign(&mut self, other: ParamFlags)
Disables all flags disabled in the set.
§impl BitOr<ParamFlags> for ParamFlags
impl BitOr<ParamFlags> for ParamFlags
§fn bitor(self, other: ParamFlags) -> ParamFlags
fn bitor(self, other: ParamFlags) -> ParamFlags
Returns the union of the two sets of flags.
§type Output = ParamFlags
type Output = ParamFlags
|
operator.§impl BitOrAssign<ParamFlags> for ParamFlags
impl BitOrAssign<ParamFlags> for ParamFlags
§fn bitor_assign(&mut self, other: ParamFlags)
fn bitor_assign(&mut self, other: ParamFlags)
Adds the set of flags.
§impl BitXor<ParamFlags> for ParamFlags
impl BitXor<ParamFlags> for ParamFlags
§fn bitxor(self, other: ParamFlags) -> ParamFlags
fn bitxor(self, other: ParamFlags) -> ParamFlags
Returns the left flags, but with all the right flags toggled.
§type Output = ParamFlags
type Output = ParamFlags
^
operator.§impl BitXorAssign<ParamFlags> for ParamFlags
impl BitXorAssign<ParamFlags> for ParamFlags
§fn bitxor_assign(&mut self, other: ParamFlags)
fn bitxor_assign(&mut self, other: ParamFlags)
Toggles the set of flags.
§impl Clone for ParamFlags
impl Clone for ParamFlags
§fn clone(&self) -> ParamFlags
fn clone(&self) -> ParamFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for ParamFlags
impl Debug for ParamFlags
§impl Default for ParamFlags
impl Default for ParamFlags
§fn default() -> ParamFlags
fn default() -> ParamFlags
§impl Extend<ParamFlags> for ParamFlags
impl Extend<ParamFlags> for ParamFlags
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ParamFlags>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = ParamFlags>,
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
)§impl FromIterator<ParamFlags> for ParamFlags
impl FromIterator<ParamFlags> for ParamFlags
§fn from_iter<T>(iterator: T) -> ParamFlagswhere
T: IntoIterator<Item = ParamFlags>,
fn from_iter<T>(iterator: T) -> ParamFlagswhere T: IntoIterator<Item = ParamFlags>,
§impl Hash for ParamFlags
impl Hash for ParamFlags
§impl LowerHex for ParamFlags
impl LowerHex for ParamFlags
§impl Not for ParamFlags
impl Not for ParamFlags
§fn not(self) -> ParamFlags
fn not(self) -> ParamFlags
Returns the complement of this set of flags.
§type Output = ParamFlags
type Output = ParamFlags
!
operator.§impl Octal for ParamFlags
impl Octal for ParamFlags
§impl Ord for ParamFlags
impl Ord for ParamFlags
§impl PartialEq<ParamFlags> for ParamFlags
impl PartialEq<ParamFlags> for ParamFlags
§fn eq(&self, other: &ParamFlags) -> bool
fn eq(&self, other: &ParamFlags) -> bool
self
and other
values to be equal, and is used
by ==
.§impl PartialOrd<ParamFlags> for ParamFlags
impl PartialOrd<ParamFlags> for ParamFlags
§fn partial_cmp(&self, other: &ParamFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ParamFlags) -> 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 more§impl Sub<ParamFlags> for ParamFlags
impl Sub<ParamFlags> for ParamFlags
§fn sub(self, other: ParamFlags) -> ParamFlags
fn sub(self, other: ParamFlags) -> ParamFlags
Returns the set difference of the two sets of flags.
§type Output = ParamFlags
type Output = ParamFlags
-
operator.§impl SubAssign<ParamFlags> for ParamFlags
impl SubAssign<ParamFlags> for ParamFlags
§fn sub_assign(&mut self, other: ParamFlags)
fn sub_assign(&mut self, other: ParamFlags)
Disables all flags enabled in the set.