Struct gstreamer::ObjectFlags
source · pub struct ObjectFlags { /* private fields */ }
Expand description
The standard flags that an gstobject may have.
Implementations§
source§impl ObjectFlags
impl ObjectFlags
sourcepub const MAY_BE_LEAKED: Self = _
pub const MAY_BE_LEAKED: Self = _
the object is expected to stay alive even
after gst_deinit()
has been called and so should be ignored by leak
detection tools. (Since: 1.10)
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 ObjectFlags
impl Binary for ObjectFlags
source§impl BitAnd<ObjectFlags> for ObjectFlags
impl BitAnd<ObjectFlags> for ObjectFlags
source§impl BitAndAssign<ObjectFlags> for ObjectFlags
impl BitAndAssign<ObjectFlags> for ObjectFlags
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<ObjectFlags> for ObjectFlags
impl BitOr<ObjectFlags> for ObjectFlags
source§fn bitor(self, other: ObjectFlags) -> Self
fn bitor(self, other: ObjectFlags) -> Self
Returns the union of the two sets of flags.
§type Output = ObjectFlags
type Output = ObjectFlags
|
operator.source§impl BitOrAssign<ObjectFlags> for ObjectFlags
impl BitOrAssign<ObjectFlags> for ObjectFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<ObjectFlags> for ObjectFlags
impl BitXor<ObjectFlags> for ObjectFlags
source§impl BitXorAssign<ObjectFlags> for ObjectFlags
impl BitXorAssign<ObjectFlags> for ObjectFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ObjectFlags
impl Clone for ObjectFlags
source§fn clone(&self) -> ObjectFlags
fn clone(&self) -> ObjectFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ObjectFlags
impl Debug for ObjectFlags
source§impl<'de> Deserialize<'de> for ObjectFlags
impl<'de> Deserialize<'de> for ObjectFlags
source§fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
source§impl Extend<ObjectFlags> for ObjectFlags
impl Extend<ObjectFlags> for ObjectFlags
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 From<ObjectFlags> for Value
impl From<ObjectFlags> for Value
source§fn from(v: ObjectFlags) -> Self
fn from(v: ObjectFlags) -> Self
source§impl FromIterator<ObjectFlags> for ObjectFlags
impl FromIterator<ObjectFlags> for ObjectFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl<'a> FromValue<'a> for ObjectFlags
impl<'a> FromValue<'a> for ObjectFlags
§type Checker = GenericValueTypeChecker<ObjectFlags>
type Checker = GenericValueTypeChecker<ObjectFlags>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for ObjectFlags
impl HasParamSpec for ObjectFlags
type ParamSpec = ParamSpecFlags
§type SetValue = ObjectFlags
type SetValue = ObjectFlags
type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, ObjectFlags>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for ObjectFlags
impl Hash for ObjectFlags
source§impl LowerHex for ObjectFlags
impl LowerHex for ObjectFlags
source§impl Not for ObjectFlags
impl Not for ObjectFlags
source§impl Octal for ObjectFlags
impl Octal for ObjectFlags
source§impl Ord for ObjectFlags
impl Ord for ObjectFlags
source§fn cmp(&self, other: &ObjectFlags) -> Ordering
fn cmp(&self, other: &ObjectFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<ObjectFlags> for ObjectFlags
impl PartialEq<ObjectFlags> for ObjectFlags
source§fn eq(&self, other: &ObjectFlags) -> bool
fn eq(&self, other: &ObjectFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ObjectFlags> for ObjectFlags
impl PartialOrd<ObjectFlags> for ObjectFlags
source§fn partial_cmp(&self, other: &ObjectFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ObjectFlags) -> 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 Serialize for ObjectFlags
impl Serialize for ObjectFlags
source§impl StaticType for ObjectFlags
impl StaticType for ObjectFlags
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub<ObjectFlags> for ObjectFlags
impl Sub<ObjectFlags> for ObjectFlags
source§impl SubAssign<ObjectFlags> for ObjectFlags
impl SubAssign<ObjectFlags> for ObjectFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl ToValue for ObjectFlags
impl ToValue for ObjectFlags
source§impl UpperHex for ObjectFlags
impl UpperHex for ObjectFlags
source§impl ValueType for ObjectFlags
impl ValueType for ObjectFlags
§type Type = ObjectFlags
type Type = ObjectFlags
Type
from. Read moreimpl Copy for ObjectFlags
impl Eq for ObjectFlags
impl StructuralEq for ObjectFlags
impl StructuralPartialEq for ObjectFlags
Auto Trait Implementations§
impl RefUnwindSafe for ObjectFlags
impl Send for ObjectFlags
impl Sync for ObjectFlags
impl Unpin for ObjectFlags
impl UnwindSafe for ObjectFlags
Blanket Implementations§
source§impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
fn into_closure_return_value(self) -> Option<Value>
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere
T: HasParamSpec,
source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere
T: StaticType,
source§fn ensure_type()
fn ensure_type()
source§impl<T> ToSendValue for Twhere
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for Twhere
T: Send + ToValue + ?Sized,
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.