Struct gstreamer::CapsFeatures

pub struct CapsFeatures(/* private fields */);

CapsFeatures can optionally be set on a Caps to add requirements for additional features for a specific Structure. Caps structures with the same name but with a non-equal set of caps features are not compatible. If a pad supports multiple sets of features it has to add multiple equal structures with different feature sets to the caps.

Empty CapsFeatures are equivalent with the CapsFeatures that only contain GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY. ANY CapsFeatures as created by new_any() are equal to any other CapsFeatures and can be used to specify that any CapsFeatures would be supported, e.g. for elements that don’t touch buffer memory. Caps with ANY CapsFeatures are considered non-fixed and during negotiation some CapsFeatures have to be selected.

Examples for caps features would be the requirement of a specific Memory types or the requirement of having a specific GstMeta on the buffer. Features are given as a string of the format memory:GstMemoryTypeName or meta:GstMetaAPIName.

Implementations

impl CapsFeatures

pub fn new(features: impl IntoIterator<Item = impl IntoGStr>) -> Self

Creates a new CapsFeatures with the given features. The last argument must be None.

feature1

name of first feature to set

Returns

a new, empty CapsFeatures

pub fn from_quarks(features: impl IntoIterator<Item = Quark>) -> Self

pub fn new_empty() -> Self

Creates a new, empty CapsFeatures.

Returns

a new, empty CapsFeatures

pub fn new_any() -> Self

Creates a new, ANY CapsFeatures. This will be equal to any other CapsFeatures but caps with these are unfixed.

Returns

a new, ANY CapsFeatures

Methods from Deref<Target = CapsFeaturesRef>

pub fn as_ptr(&self) -> *const GstCapsFeatures

pub fn as_mut_ptr(&self) -> *mut GstCapsFeatures

pub fn is_empty(&self) -> bool

pub fn is_any(&self) -> bool

pub fn contains(&self, feature: impl IntoGStr) -> bool

pub fn contains_quark(&self, feature: Quark) -> bool

pub fn size(&self) -> usize

pub fn nth(&self, idx: usize) -> Option<&GStr>

pub fn nth_quark(&self, idx: usize) -> Option<Quark>

pub fn add(&mut self, feature: impl IntoGStr)

pub fn remove(&mut self, feature: impl IntoGStr)

pub fn add_from_quark(&mut self, feature: Quark)

pub fn remove_by_quark(&mut self, feature: Quark)

pub fn iter(&self) -> Iter<'_>

pub fn is_equal(&self, other: &CapsFeaturesRef) -> bool

Trait Implementations

impl AsMut<CapsFeaturesRef> for CapsFeatures

fn as_mut(&mut self) -> &mut CapsFeaturesRef

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<CapsFeaturesRef> for CapsFeatures

fn as_ref(&self) -> &CapsFeaturesRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<CapsFeaturesRef> for CapsFeatures

fn borrow(&self) -> &CapsFeaturesRef

Immutably borrows from an owned value.

impl BorrowMut<CapsFeaturesRef> for CapsFeatures

fn borrow_mut(&mut self) -> &mut CapsFeaturesRef

Mutably borrows from an owned value.

impl Clone for CapsFeatures

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CapsFeatures

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for CapsFeatures

type Target = CapsFeaturesRef

The resulting type after dereferencing.

fn deref(&self) -> &CapsFeaturesRef

Dereferences the value.

impl DerefMut for CapsFeatures

fn deref_mut(&mut self) -> &mut CapsFeaturesRef

Mutably dereferences the value.

impl<'de> Deserialize<'de> for CapsFeatures

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for CapsFeatures

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for CapsFeatures

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&'a GStr> for CapsFeatures

fn from(value: &'a GStr) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for CapsFeatures

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a, const N: usize> From<[&'a GStr; N]> for CapsFeatures

fn from(value: [&'a GStr; N]) -> Self

Converts to this type from the input type.

impl<'a, const N: usize> From<[&'a str; N]> for CapsFeatures

fn from(value: [&'a str; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[GString; N]> for CapsFeatures

fn from(value: [GString; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[Quark; N]> for CapsFeatures

fn from(value: [Quark; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[String; N]> for CapsFeatures

fn from(value: [String; N]) -> Self

Converts to this type from the input type.

impl From<CapsFeatures> for Value

fn from(v: CapsFeatures) -> Value

Converts to this type from the input type.

impl From<Quark> for CapsFeatures

fn from(value: Quark) -> Self

Converts to this type from the input type.

impl FromGlibPtrFull<*const GstCapsFeatures> for CapsFeatures

unsafe fn from_glib_full(ptr: *const GstCapsFeatures) -> Self

Safety

impl FromGlibPtrFull<*mut GstCapsFeatures> for CapsFeatures

unsafe fn from_glib_full(ptr: *mut GstCapsFeatures) -> Self

Safety

impl FromGlibPtrNone<*const GstCapsFeatures> for CapsFeatures

unsafe fn from_glib_none(ptr: *const GstCapsFeatures) -> Self

Safety

impl FromGlibPtrNone<*mut GstCapsFeatures> for CapsFeatures

unsafe fn from_glib_none(ptr: *mut GstCapsFeatures) -> Self

Safety

impl<'a> FromIterator<&'a GStr> for CapsFeatures

fn from_iter<T: IntoIterator<Item = &'a GStr>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> FromIterator<&'a str> for CapsFeatures

fn from_iter<T: IntoIterator<Item = &'a str>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<GString> for CapsFeatures

fn from_iter<T: IntoIterator<Item = GString>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Quark> for CapsFeatures

fn from_iter<T: IntoIterator<Item = Quark>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<String> for CapsFeatures

fn from_iter<T: IntoIterator<Item = String>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for CapsFeatures

type Err = BoolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a> FromValue<'a> for CapsFeatures

type Checker = GenericValueTypeOrNoneChecker<CapsFeatures>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl GlibPtrDefault for CapsFeatures

type GlibType = *mut GstCapsFeatures

impl IntoGlibPtr<*mut GstCapsFeatures> for CapsFeatures

unsafe fn into_glib_ptr(self) -> *mut GstCapsFeatures

Transfer: full.

impl Serialize for CapsFeatures

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StaticType for CapsFeatures

fn static_type() -> Type

Returns the type identifier of Self.

impl<'a> ToGlibPtr<'a, *const GstCapsFeatures> for CapsFeatures

type Storage = PhantomData<&'a CapsFeatures>

fn to_glib_none(&'a self) -> Stash<'a, *const GstCapsFeatures, Self>

Transfer: none.

fn to_glib_full(&self) -> *const GstCapsFeatures

Transfer: full.

fn to_glib_container(&'a self) -> Stash<'a, P, Self>

Transfer: container.

impl<'a> ToGlibPtr<'a, *mut GstCapsFeatures> for CapsFeatures

type Storage = PhantomData<&'a CapsFeatures>

fn to_glib_none(&'a self) -> Stash<'a, *mut GstCapsFeatures, Self>

Transfer: none.

fn to_glib_full(&self) -> *mut GstCapsFeatures

Transfer: full.

fn to_glib_container(&'a self) -> Stash<'a, P, Self>

Transfer: container.

impl<'a> ToGlibPtrMut<'a, *mut GstCapsFeatures> for CapsFeatures

type Storage = PhantomData<&'a mut CapsFeatures>

fn to_glib_none_mut(&'a mut self) -> StashMut<'_, *mut GstCapsFeatures, Self>

Transfer: none.

impl ToValue for CapsFeatures

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ToValueOptional for CapsFeatures

fn to_value_optional(s: Option<&Self>) -> Value

Convert an Option to a Value.

impl ValueType for CapsFeatures

type Type = CapsFeatures

Type to get the Type from.

impl Send for CapsFeatures

impl Sync for CapsFeatures

impl TransparentPtrType for CapsFeatures

impl ValueTypeOptional for CapsFeatures