Struct gstreamer::caps::Caps

pub struct Caps { /* private fields */ }

Implementations

impl Caps

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GstCaps) -> &Self

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

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

pub unsafe fn from_glib_borrow(ptr: *const GstCaps) -> Borrowed<Self>

pub unsafe fn replace_ptr(&mut self, ptr: *mut GstCaps)

pub fn make_mut(&mut self) -> &mut CapsRef

pub fn get_mut(&mut self) -> Option<&mut CapsRef>

pub fn is_writable(&self) -> bool

pub fn upcast(self) -> MiniObject

impl Caps

pub fn builder(name: impl IntoGStr) -> Builder<NoFeature>

pub fn builder_full() -> BuilderFull<SomeFeatures>

pub fn builder_full_with_features( features: CapsFeatures, ) -> BuilderFull<SomeFeatures>

pub fn builder_full_with_any_features() -> BuilderFull<AnyFeatures>

pub fn new_empty() -> Self

Creates a new Caps that is empty. That is, the returned Caps contains no media formats. The Caps is guaranteed to be writable.

Returns

the new Caps

pub fn new_any() -> Self

Creates a new Caps that indicates that it is compatible with any media format.

Returns

the new Caps

pub fn new_empty_simple(name: impl IntoGStr) -> Self

Creates a new Caps that contains one Structure with name media_type.

media_type

the media type of the structure

Returns

the new Caps

pub fn fixate(&mut self)

Modifies the given self into a representation with only fixed values. First the caps will be truncated and then the first structure will be fixated with gst_structure_fixate().

This function takes ownership of self and will call gst_caps_make_writable() on it so you must not use self afterwards unless you keep an additional reference to it with gst_caps_ref().

Note that it is not guaranteed that the returned caps have exactly one structure. If self are empty caps then the returned caps will be the empty too and contain no structure at all.

Calling this function with ANY caps is not allowed.

Returns

the fixated caps

pub fn merge(&mut self, other: Self)

Appends the structures contained in caps2 to self if they are not yet expressed by self. The structures in caps2 are not copied – they are transferred to a writable copy of self, and then caps2 is freed. If either caps is ANY, the resulting caps will be ANY.

caps2

the Caps to merge in

Returns

the merged caps.

pub fn merge_structure(&mut self, structure: Structure)

Appends structure to self if it is not already expressed by self.

structure

the Structure to merge

Returns

the merged caps.

pub fn merge_structure_full( &mut self, structure: Structure, features: Option<CapsFeatures>, )

Appends structure with features to self if its not already expressed by self.

structure

the Structure to merge

features

the CapsFeatures to merge

Returns

the merged caps.

pub fn normalize(&mut self)

Returns a Caps that represents the same set of formats as self, but contains no lists. Each list is expanded into separate Structure.

This function takes ownership of self and will call gst_caps_make_writable() on it so you must not use self afterwards unless you keep an additional reference to it with gst_caps_ref().

Returns

the normalized Caps

pub fn simplify(&mut self)

Converts the given self into a representation that represents the same set of formats, but in a simpler form. Component structures that are identical are merged. Component structures that have values that can be merged are also merged.

This function takes ownership of self and will call gst_caps_make_writable() on it if necessary, so you must not use self afterwards unless you keep an additional reference to it with gst_caps_ref().

This method does not preserve the original order of self.

Returns

The simplified caps.

pub fn truncate(&mut self)

Discards all but the first structure from self. Useful when fixating.

This function takes ownership of self and will call gst_caps_make_writable() on it if necessary, so you must not use self afterwards unless you keep an additional reference to it with gst_caps_ref().

Note that it is not guaranteed that the returned caps have exactly one structure. If self is any or empty caps then the returned caps will be the same and contain no structure at all.

Returns

truncated caps

Methods from Deref<Target = CapsRef>

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

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

pub fn copy(&self) -> Caps

pub fn upcast_ref(&self) -> &MiniObjectRef

pub fn structure(&self, idx: usize) -> Option<&StructureRef>

pub fn features(&self, idx: usize) -> Option<&CapsFeaturesRef>

pub fn size(&self) -> usize

pub fn len(&self) -> usize

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

pub fn iter_with_features(&self) -> IterFeatures<'_>

pub fn can_intersect(&self, other: &Self) -> bool

pub fn intersect(&self, other: &Self) -> Caps

pub fn intersect_with_mode(&self, other: &Self, mode: CapsIntersectMode) -> Caps

pub fn is_always_compatible(&self, other: &Self) -> bool

pub fn is_any(&self) -> bool

pub fn is_empty(&self) -> bool

pub fn is_fixed(&self) -> bool

pub fn is_equal_fixed(&self, other: &Self) -> bool

pub fn is_strictly_equal(&self, other: &Self) -> bool

pub fn is_subset(&self, superset: &Self) -> bool

pub fn is_subset_structure(&self, structure: &StructureRef) -> bool

pub fn is_subset_structure_full( &self, structure: &StructureRef, features: Option<&CapsFeaturesRef>, ) -> bool

pub fn subtract(&self, other: &Self) -> Caps

pub fn serialize(&self, flags: SerializeFlags) -> GString

pub fn foreach<F: FnMut(&CapsFeaturesRef, &StructureRef) -> ControlFlow<()>>( &self, func: F, ) -> bool

Trait Implementations

impl AsRef<CapsRef> for Caps

fn as_ref(&self) -> &CapsRef

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

impl Borrow<CapsRef> for Caps

fn borrow(&self) -> &CapsRef

Immutably borrows from an owned value.

impl Clone for Caps

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 Caps

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

Formats the value using the given formatter.

impl Deref for Caps

type Target = CapsRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Caps

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

Deserialize this value from the given Serde deserializer.

impl Display for Caps

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

Formats the value using the given formatter.

impl Drop for Caps

fn drop(&mut self)

Executes the destructor for this type.

impl Extend<Caps> for CapsRef

fn extend<T: IntoIterator<Item = Caps>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<const N: usize> From<[(Structure, CapsFeatures); N]> for Caps

fn from(v: [(Structure, CapsFeatures); N]) -> Caps

Converts to this type from the input type.

impl<const N: usize> From<[(Structure, Option<CapsFeatures>); N]> for Caps

fn from(v: [(Structure, Option<CapsFeatures>); N]) -> Caps

Converts to this type from the input type.

impl<const N: usize> From<[Structure; N]> for Caps

fn from(v: [Structure; N]) -> Caps

Converts to this type from the input type.

impl From<(Structure, CapsFeatures)> for Caps

fn from(v: (Structure, CapsFeatures)) -> Caps

Converts to this type from the input type.

impl From<Caps> for Value

fn from(v: Caps) -> Value

Converts to this type from the input type.

impl From<Structure> for Caps

fn from(v: Structure) -> Caps

Converts to this type from the input type.

impl FromGlibContainerAsVec<*mut GstCaps, *const *mut GstCaps> for Caps

unsafe fn from_glib_none_num_as_vec( ptr: *const *mut GstCaps, num: usize, ) -> Vec<Self>

unsafe fn from_glib_container_num_as_vec( _: *const *mut GstCaps, _: usize, ) -> Vec<Self>

unsafe fn from_glib_full_num_as_vec( _: *const *mut GstCaps, _: usize, ) -> Vec<Self>

impl FromGlibContainerAsVec<*mut GstCaps, *mut *mut GstCaps> for Caps

unsafe fn from_glib_none_num_as_vec( ptr: *mut *mut GstCaps, num: usize, ) -> Vec<Self>

unsafe fn from_glib_container_num_as_vec( ptr: *mut *mut GstCaps, num: usize, ) -> Vec<Self>

unsafe fn from_glib_full_num_as_vec( ptr: *mut *mut GstCaps, num: usize, ) -> Vec<Self>

impl FromGlibPtrArrayContainerAsVec<*mut GstCaps, *const *mut GstCaps> for Caps

unsafe fn from_glib_none_as_vec(ptr: *const *mut GstCaps) -> Vec<Self>

unsafe fn from_glib_container_as_vec(_: *const *mut GstCaps) -> Vec<Self>

unsafe fn from_glib_full_as_vec(_: *const *mut GstCaps) -> Vec<Self>

impl FromGlibPtrArrayContainerAsVec<*mut GstCaps, *mut *mut GstCaps> for Caps

unsafe fn from_glib_none_as_vec(ptr: *mut *mut GstCaps) -> Vec<Self>

unsafe fn from_glib_container_as_vec(ptr: *mut *mut GstCaps) -> Vec<Self>

unsafe fn from_glib_full_as_vec(ptr: *mut *mut GstCaps) -> Vec<Self>

impl FromGlibPtrBorrow<*const GstCaps> for Caps

unsafe fn from_glib_borrow(ptr: *const GstCaps) -> Borrowed<Self>

Safety

impl FromGlibPtrBorrow<*mut GstCaps> for Caps

unsafe fn from_glib_borrow(ptr: *mut GstCaps) -> Borrowed<Self>

Safety

impl FromGlibPtrFull<*const GstCaps> for Caps

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

Safety

impl FromGlibPtrFull<*mut GstCaps> for Caps

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

Safety

impl FromGlibPtrNone<*const GstCaps> for Caps

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

Safety

impl FromGlibPtrNone<*mut GstCaps> for Caps

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

Safety

impl FromIterator<(Structure, CapsFeatures)> for Caps

fn from_iter<T: IntoIterator<Item = (Structure, CapsFeatures)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<(Structure, Option<CapsFeatures>)> for Caps

fn from_iter<T: IntoIterator<Item = (Structure, Option<CapsFeatures>)>>( iter: T, ) -> Self

Creates a value from an iterator.

impl FromIterator<Caps> for Caps

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

Creates a value from an iterator.

impl FromIterator<Structure> for Caps

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

Creates a value from an iterator.

impl FromStr for Caps

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 &'a Caps

type Checker = GenericValueTypeOrNoneChecker<&'a Caps>

Value type checker.

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

Get the contained value from a Value.

impl<'a> FromValue<'a> for Caps

type Checker = GenericValueTypeOrNoneChecker<Caps>

Value type checker.

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

Get the contained value from a Value.

impl GlibPtrDefault for Caps

type GlibType = *mut GstCaps

impl HasParamSpec for Caps

type ParamSpec = ParamSpecBoxed

type SetValue = Caps

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, Caps>

fn param_spec_builder() -> Self::BuilderFn

impl IntoGlibPtr<*mut GstCaps> for Caps

unsafe fn into_glib_ptr(self) -> *mut GstCaps

Transfer: full.

impl IsMiniObject for Caps

type RefType = CapsRef

type FfiType = GstCaps

impl PartialEq<Caps> for CapsRef

fn eq(&self, other: &Caps) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<CapsRef> for Caps

fn eq(&self, other: &CapsRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Caps

fn eq(&self, other: &Caps) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Caps

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

Serialize this value into the given Serde serializer.

impl StaticType for Caps

fn static_type() -> Type

Returns the type identifier of Self.

impl<'a> ToGlibContainerFromSlice<'a, *const *mut GstCaps> for Caps

type Storage = (PhantomData<&'a [Caps]>, Option<Vec<*mut GstCaps>>)

fn to_glib_none_from_slice( t: &'a [Caps], ) -> (*const *mut GstCaps, Self::Storage)

fn to_glib_container_from_slice( _: &'a [Caps], ) -> (*const *mut GstCaps, Self::Storage)

fn to_glib_full_from_slice(_: &[Caps]) -> *const *mut GstCaps

impl<'a> ToGlibContainerFromSlice<'a, *mut *mut GstCaps> for Caps

type Storage = (PhantomData<&'a [Caps]>, Option<Vec<*mut GstCaps>>)

fn to_glib_none_from_slice(t: &'a [Caps]) -> (*mut *mut GstCaps, Self::Storage)

fn to_glib_container_from_slice( t: &'a [Caps], ) -> (*mut *mut GstCaps, Self::Storage)

fn to_glib_full_from_slice(t: &[Caps]) -> *mut *mut GstCaps

impl<'a> ToGlibPtr<'a, *const GstCaps> for Caps

type Storage = PhantomData<&'a Caps>

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

Transfer: none.

fn to_glib_full(&self) -> *const GstCaps

Transfer: full.

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

Transfer: container.

impl<'a> ToGlibPtr<'a, *mut GstCaps> for Caps

type Storage = PhantomData<&'a Caps>

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

Transfer: none.

fn to_glib_full(&self) -> *mut GstCaps

Transfer: full.

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

Transfer: container.

impl<'a> ToGlibPtrMut<'a, *mut GstCaps> for Caps

type Storage = PhantomData<&'a mut Caps>

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

Transfer: none.

impl ToValue for Caps

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 Caps

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

Convert an Option to a Value.

impl ValueType for Caps

type Type = Caps

Type to get the Type from.

impl Eq for Caps

impl Send for Caps

impl Sync for Caps

impl TransparentPtrType for Caps

impl ValueTypeOptional for Caps