Struct gstreamer::structure::StructureRef

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

Implementations

impl StructureRef

pub unsafe fn from_glib_borrow<'a>(ptr: *const GstStructure) -> &'a StructureRef

pub unsafe fn from_glib_borrow_mut<'a>( ptr: *mut GstStructure, ) -> &'a mut StructureRef

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

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

pub fn get<'a, T: FromValue<'a>>( &'a self, name: impl IntoGStr, ) -> Result<T, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

pub fn get_optional<'a, T: FromValue<'a>>( &'a self, name: impl IntoGStr, ) -> Result<Option<T>, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

pub fn value( &self, name: impl IntoGStr, ) -> Result<&SendValue, GetError<Infallible>>

pub fn get_by_quark<'a, T: FromValue<'a>>( &'a self, name: Quark, ) -> Result<T, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

pub fn get_optional_by_quark<'a, T: FromValue<'a>>( &'a self, name: Quark, ) -> Result<Option<T>, GetError<<<T as FromValue<'a>>::Checker as ValueTypeChecker>::Error>>

pub fn value_by_quark( &self, name: Quark, ) -> Result<&SendValue, GetError<Infallible>>

pub fn set(&mut self, name: impl IntoGStr, value: impl Into<Value> + Send)

Sets field name to the given value value.

Overrides any default or previously defined value for name.

pub fn set_if( &mut self, name: impl IntoGStr, value: impl Into<Value> + Send, predicate: bool, )

Sets field name to the given inner value if value is Some.

This has no effect if the predicate evaluates to false, i.e. default or previous value for name is kept.

pub fn set_if_some( &mut self, name: impl IntoGStr, value: Option<impl Into<Value> + Send>, )

Sets field name to the given inner value if value is Some.

This has no effect if the value is None, i.e. default or previous value for name is kept.

pub fn set_from_iter<V: ValueType + Into<Value> + FromIterator<SendValue> + Send>( &mut self, name: impl IntoGStr, iter: impl IntoIterator<Item = impl ToSendValue>, )

Sets field name using the given ValueType V built from iter’s the Items.

Overrides any default or previously defined value for name.

pub fn set_if_not_empty<V: ValueType + Into<Value> + FromIterator<SendValue> + Send>( &mut self, name: impl IntoGStr, iter: impl IntoIterator<Item = impl ToSendValue>, )

Sets field name using the given ValueType V built from iter’s Items, if iter` is not empty.

This has no effect if iter is empty, i.e. previous value for name is unchanged.

pub fn set_value(&mut self, name: impl IntoGStr, value: SendValue)

Sets field name to the given value value.

Overrides any default or previously defined value for name.

pub fn set_value_if( &mut self, name: impl IntoGStr, value: SendValue, predicate: bool, )

Sets field name to the given inner value if value is Some.

This has no effect if the predicate evaluates to false, i.e. default or previous value for name is kept.

pub fn set_value_if_some( &mut self, name: impl IntoGStr, value: Option<SendValue>, )

Sets field name to the given inner value if value is Some.

This has no effect if the value is None, i.e. default or previous value for name is kept.

pub fn set_by_quark(&mut self, name: Quark, value: impl Into<Value> + Send)

pub fn set_by_quark_if_some( &mut self, name: Quark, value: Option<impl Into<Value> + Send>, )

pub fn set_value_by_quark(&mut self, name: Quark, value: SendValue)

pub fn set_value_by_quark_if_some( &mut self, name: Quark, value: Option<SendValue>, )

pub fn name<'a>(&self) -> &'a GStr

pub fn name_quark(&self) -> Quark

pub fn set_name(&mut self, name: impl IntoGStr)

pub fn set_name_if_some(&mut self, name: Option<impl IntoGStr>)

pub fn has_name(&self, name: &str) -> bool

pub fn has_field(&self, field: impl IntoGStr) -> bool

pub fn has_field_with_type(&self, field: impl IntoGStr, type_: Type) -> bool

pub fn has_field_by_quark(&self, field: Quark) -> bool

pub fn has_field_with_type_by_quark(&self, field: Quark, type_: Type) -> bool

pub fn remove_field(&mut self, field: impl IntoGStr)

pub fn remove_fields(&mut self, fields: impl IntoIterator<Item = impl IntoGStr>)

pub fn remove_all_fields(&mut self)

pub fn fields(&self) -> FieldIterator<'_>

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

pub fn nth_field_name<'a>(&self, idx: usize) -> Option<&'a GStr>

pub fn n_fields(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

pub fn intersect(&self, other: &StructureRef) -> Option<Structure>

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

pub fn fixate(&mut self)

pub fn fixate_field(&mut self, name: impl IntoGStr) -> bool

pub fn fixate_field_bool(&mut self, name: impl IntoGStr, target: bool) -> bool

pub fn fixate_field_str( &mut self, name: impl IntoGStr, target: impl IntoGStr, ) -> bool

pub fn fixate_field_nearest_double( &mut self, name: impl IntoGStr, target: f64, ) -> bool

pub fn fixate_field_nearest_fraction( &mut self, name: impl IntoGStr, target: impl Into<Fraction>, ) -> bool

pub fn fixate_field_nearest_int( &mut self, name: impl IntoGStr, target: i32, ) -> bool

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

pub fn serialize_strict( &self, flags: SerializeFlags, ) -> Result<GString, BoolError>

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

pub fn map_in_place<F: FnMut(Quark, &mut Value) -> ControlFlow<()>>( &mut self, func: F, ) -> bool

pub fn filter_map_in_place<F: FnMut(Quark, Value) -> Option<Value>>( &mut self, func: F, )

Trait Implementations

impl AsMut<StructureRef> for BufferPoolConfigRef

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

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

impl AsMut<StructureRef> for Structure

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

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

impl AsRef<StructureRef> for BufferPoolConfigRef

fn as_ref(&self) -> &StructureRef

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

impl AsRef<StructureRef> for Structure

fn as_ref(&self) -> &StructureRef

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

impl Borrow<StructureRef> for Structure

fn borrow(&self) -> &StructureRef

Immutably borrows from an owned value.

impl BorrowMut<StructureRef> for Structure

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

Mutably borrows from an owned value.

impl Debug for StructureRef

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

Formats the value using the given formatter.

impl Display for StructureRef

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

Formats the value using the given formatter.

impl<'a> Extend<(&'a GStr, SendValue)> for StructureRef

fn extend<T: IntoIterator<Item = (&'a GStr, SendValue)>>(&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<'a> Extend<(&'a str, SendValue)> for StructureRef

fn extend<T: IntoIterator<Item = (&'a str, SendValue)>>(&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 Extend<(GString, SendValue)> for StructureRef

fn extend<T: IntoIterator<Item = (GString, SendValue)>>(&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 Extend<(Quark, SendValue)> for StructureRef

fn extend<T: IntoIterator<Item = (Quark, SendValue)>>(&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 Extend<(String, SendValue)> for StructureRef

fn extend<T: IntoIterator<Item = (String, SendValue)>>(&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<'a> FromValue<'a> for &'a StructureRef

type Checker = GenericValueTypeOrNoneChecker<&'a StructureRef>

Value type checker.

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

Get the contained value from a Value.

impl<'a> IntoIterator for &'a StructureRef

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

type Item = (&'static GStr, &'a SendValue)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Structure> for StructureRef

fn eq(&self, other: &Structure) -> 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<StructureRef> for Structure

fn eq(&self, other: &StructureRef) -> 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 StructureRef

fn eq(&self, other: &StructureRef) -> 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 StructureRef

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

Serialize this value into the given Serde serializer.

impl StaticType for StructureRef

fn static_type() -> Type

Returns the type identifier of Self.

impl ToOwned for StructureRef

type Owned = Structure

The resulting type after obtaining ownership.

fn to_owned(&self) -> Structure

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl ToValue for StructureRef

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 StructureRef

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

Convert an Option to a Value.

impl Eq for StructureRef

impl Send for StructureRef

impl Sync for StructureRef