Struct ElementPropertiesMapItem

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

Wrapper around gst::Structure for element-properties-map map item.

Examples

ElementProperties::builder_map()
    .item(
        ElementPropertiesMapItem::builder("vp8enc")
            .field("max-quantizer", 17)
            .field("buffer-size", 20000)
            .field("threads", 16)
            .build(),
    )
    .build();

Implementations

impl ElementPropertiesMapItem

pub fn builder(factory_name: &str) -> ElementPropertiesMapItemBuilder

pub fn into_inner(self) -> Structure

Methods from Deref<Target = StructureRef>

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

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

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

where T: FromValue<'a>,

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

where T: FromValue<'a>,

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

where T: FromValue<'a>,

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

where T: FromValue<'a>,

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

pub fn value_by_id( &self, name: impl AsRef<IdStr>, ) -> Result<&SendValue, GetError<Infallible>>

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

where T: FromValue<'a>,

👎Deprecated: use get_by_id() instead

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

where T: FromValue<'a>,

👎Deprecated: use get_optional_by_id() instead

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

👎Deprecated: use value_by_id() instead

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_with_static( &mut self, name: impl AsRef<GStr> + 'static, 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_with_id( &mut self, name: impl AsRef<IdStr>, 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 value if the predicate evaluates to true.

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

pub fn set_with_static_if( &mut self, name: impl AsRef<GStr> + 'static, value: impl Into<Value> + Send, predicate: bool, )

Sets field name to the given value if the predicate evaluates to true.

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

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

Sets field name to the given value if the predicate evaluates to true.

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_with_static_if_some( &mut self, name: impl AsRef<GStr> + 'static, 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_with_id_if_some( &mut self, name: impl AsRef<IdStr>, 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>( &mut self, name: impl IntoGStr, iter: impl IntoIterator<Item = impl ToSendValue>, )

where V: ValueType + Into<Value> + FromIterator<SendValue> + Send,

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_with_static_from_iter<V>( &mut self, name: impl AsRef<GStr> + 'static, iter: impl IntoIterator<Item = impl ToSendValue>, )

where V: ValueType + Into<Value> + FromIterator<SendValue> + Send,

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_with_id_from_iter<V>( &mut self, name: impl AsRef<IdStr>, iter: impl IntoIterator<Item = impl ToSendValue>, )

where V: ValueType + Into<Value> + FromIterator<SendValue> + Send,

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>( &mut self, name: impl IntoGStr, iter: impl IntoIterator<Item = impl ToSendValue>, )

where V: ValueType + Into<Value> + FromIterator<SendValue> + Send,

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_with_static_if_not_empty<V>( &mut self, name: impl AsRef<GStr> + 'static, iter: impl IntoIterator<Item = impl ToSendValue>, )

where V: ValueType + Into<Value> + FromIterator<SendValue> + Send,

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_with_id_if_not_empty<V>( &mut self, name: impl AsRef<IdStr>, iter: impl IntoIterator<Item = impl ToSendValue>, )

where V: ValueType + Into<Value> + FromIterator<SendValue> + Send,

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_with_static( &mut self, name: impl AsRef<GStr> + 'static, value: SendValue, )

Sets field name to the given value value.

Overrides any default or previously defined value for name.

pub fn set_value_with_id(&mut self, name: impl AsRef<IdStr>, 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 value if the predicate evaluates to true.

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

pub fn set_value_with_static_if( &mut self, name: impl AsRef<GStr> + 'static, value: SendValue, predicate: bool, )

Sets field name to the given value if the predicate evaluates to true.

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

pub fn set_value_with_id_if( &mut self, name: impl AsRef<IdStr>, value: SendValue, predicate: bool, )

Sets field name to the given value if the predicate evaluates to true.

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_value_with_static_if_some( &mut self, name: impl AsRef<GStr> + 'static, 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_value_with_id_if_some( &mut self, name: impl AsRef<IdStr>, 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)

👎Deprecated: use set_by_id() instead

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

👎Deprecated: use set_by_id_if_some() instead

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

👎Deprecated: use set_by_id_value() instead

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

👎Deprecated: use set_by_id_value_if_some() instead

pub fn name(&self) -> &GStr

pub fn name_id(&self) -> &IdStr

pub fn name_quark(&self) -> Quark

👎Deprecated: use name() instead, or name_id() with feature v1_26

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

pub fn set_name_from_static(&mut self, name: impl AsRef<GStr> + 'static)

pub fn set_name_from_id(&mut self, name: impl AsRef<IdStr>)

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

pub fn set_name_from_static_if_some( &mut self, name: Option<impl AsRef<GStr> + 'static>, )

pub fn set_name_from_id_if_some(&mut self, name: Option<impl AsRef<IdStr>>)

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

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

pub fn has_field_by_id(&self, field: impl AsRef<IdStr>) -> bool

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

pub fn has_field_with_type_by_id( &self, field: impl AsRef<IdStr>, type_: Type, ) -> bool

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

👎Deprecated: use has_field_by_id()

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

👎Deprecated: use has_field_with_type_by_id()

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

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

pub fn remove_field_by_id(&mut self, field: impl AsRef<IdStr>)

pub fn remove_field_by_ids( &mut self, fields: impl IntoIterator<Item = impl AsRef<IdStr>>, )

pub fn remove_all_fields(&mut self)

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

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

pub fn field_ids(&self) -> FieldIdIterator<'_>

pub fn id_iter(&self) -> IdIter<'_>

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

pub fn nth_field_by_id(&self, idx: usize) -> Option<&IdStr>

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>(&self, func: F) -> bool

where F: FnMut(Quark, &Value) -> ControlFlow<()>,

👎Deprecated: Use iter() instead, or id_iter() with feature v1_26

pub fn map_in_place_by_id<F>(&mut self, func: F)

where F: FnMut(&IdStr, &mut Value) -> ControlFlow<()>,

Executes the provided func on each field, possibly modifying the value.

pub fn filter_map_in_place_by_id<F>(&mut self, func: F)

where F: FnMut(&IdStr, Value) -> Option<Value>,

Executes the provided func on each field with an owned value.

• If func returns Some(value), the field’s value is replaced with value.
• If func returns None, the field is removed.

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

where F: FnMut(Quark, &mut Value) -> ControlFlow<()>,

Executes the provided func on each field, possibly modifying the value, as long as ControlFlow::Continue(()) is returned.

Using Quarks is deprecated, however this method is kept because there are no other means to achieve this pre-GStreamer-1.26. With feature v1_26, use map_in_place_by_id instead.

Returns:

• ControlFlow::Continue(()) if func returned this for all fields,
• ControlFlow::Break(()) otherwise.

pub fn filter_map_in_place<F>(&mut self, func: F)

where F: FnMut(Quark, Value) -> Option<Value>,

Executes the provided func on each field with an owned value.

• If func returns Some(value), the field’s value is replaced with value.
• If func returns None, the field is removed.

Using Quarks is deprecated, however this method is kept because there are no other means to achieve this pre-GStreamer-1.26. With feature v1_26, use filter_map_in_place_by_id instead.

Trait Implementations

impl Clone for ElementPropertiesMapItem

fn clone(&self) -> ElementPropertiesMapItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ElementPropertiesMapItem

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

Formats the value using the given formatter.

impl Deref for ElementPropertiesMapItem

type Target = StructureRef

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for ElementPropertiesMapItem

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<ElementPropertiesMapItem> for Structure

fn from(e: ElementPropertiesMapItem) -> Self

Converts to this type from the input type.

impl PartialEq for ElementPropertiesMapItem

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ElementPropertiesMapItem

impl StructuralPartialEq for ElementPropertiesMapItem