Struct gstreamer::ObjectFlags
source · [−]pub struct ObjectFlags { /* private fields */ }
Implementations
sourceimpl ObjectFlags
impl ObjectFlags
pub const MAY_BE_LEAKED: Self = Self{bits: ffi::GST_OBJECT_FLAG_MAY_BE_LEAKED as u32,}
v1_10
only.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 ObjectFlags
impl Binary for ObjectFlags
sourceimpl BitAnd<ObjectFlags> for ObjectFlags
impl BitAnd<ObjectFlags> for ObjectFlags
type Output = ObjectFlags
type Output = ObjectFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<ObjectFlags> for ObjectFlags
impl BitAndAssign<ObjectFlags> for ObjectFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ObjectFlags> for ObjectFlags
impl BitOr<ObjectFlags> for ObjectFlags
sourcefn 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
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<ObjectFlags> for ObjectFlags
impl BitOrAssign<ObjectFlags> for ObjectFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ObjectFlags> for ObjectFlags
impl BitXor<ObjectFlags> for ObjectFlags
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 = ObjectFlags
type Output = ObjectFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<ObjectFlags> for ObjectFlags
impl BitXorAssign<ObjectFlags> for ObjectFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ObjectFlags
impl Clone for ObjectFlags
sourcefn clone(&self) -> ObjectFlags
fn clone(&self) -> ObjectFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ObjectFlags
impl Debug for ObjectFlags
sourceimpl Extend<ObjectFlags> for ObjectFlags
impl Extend<ObjectFlags> for ObjectFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<ObjectFlags> for ObjectFlags
impl FromIterator<ObjectFlags> for ObjectFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl<'a> FromValue<'a> for ObjectFlags
impl<'a> FromValue<'a> for ObjectFlags
type Checker = GenericValueTypeChecker<ObjectFlags>
type Checker = GenericValueTypeChecker<ObjectFlags>
Value type checker.
sourceunsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Get the contained value from a Value
. Read more
sourceimpl Hash for ObjectFlags
impl Hash for ObjectFlags
sourceimpl LowerHex for ObjectFlags
impl LowerHex for ObjectFlags
sourceimpl Not for ObjectFlags
impl Not for ObjectFlags
type Output = ObjectFlags
type Output = ObjectFlags
The resulting type after applying the !
operator.
sourceimpl Octal for ObjectFlags
impl Octal for ObjectFlags
sourceimpl Ord for ObjectFlags
impl Ord for ObjectFlags
sourceimpl PartialEq<ObjectFlags> for ObjectFlags
impl PartialEq<ObjectFlags> for ObjectFlags
sourcefn eq(&self, other: &ObjectFlags) -> bool
fn eq(&self, other: &ObjectFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ObjectFlags) -> bool
fn ne(&self, other: &ObjectFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ObjectFlags> for ObjectFlags
impl PartialOrd<ObjectFlags> for ObjectFlags
sourcefn partial_cmp(&self, other: &ObjectFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ObjectFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl StaticType for ObjectFlags
impl StaticType for ObjectFlags
sourcefn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of Self
.
sourceimpl Sub<ObjectFlags> for ObjectFlags
impl Sub<ObjectFlags> for ObjectFlags
type Output = ObjectFlags
type Output = ObjectFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<ObjectFlags> for ObjectFlags
impl SubAssign<ObjectFlags> for ObjectFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl ToValue for ObjectFlags
impl ToValue for ObjectFlags
sourceimpl UpperHex for ObjectFlags
impl UpperHex for ObjectFlags
sourceimpl ValueType for ObjectFlags
impl ValueType for ObjectFlags
type Type = ObjectFlags
type Type = ObjectFlags
Type to get the Type
from. Read more
impl 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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> StaticTypeExt for T where
T: StaticType,
impl<T> StaticTypeExt for T where
T: StaticType,
sourcefn ensure_type()
fn ensure_type()
Ensures that the type has been registered with the type system.
sourceimpl<T> ToClosureReturnValue for T where
T: ToValue,
impl<T> ToClosureReturnValue for T where
T: ToValue,
fn to_closure_return_value(&self) -> Option<Value>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
sourcefn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
Returns a SendValue
clone of self
.