Struct gstreamer::structure::Structure

pub struct Structure(_, _);

A Structure is a collection of key/value pairs. The keys are expressed as GQuarks and the values can be of any GType.

In addition to the key/value pairs, a Structure also has a name. The name starts with a letter and can be filled by letters, numbers and any of "/-_.:".

Structure is used by various GStreamer subsystems to store information in a flexible and extensible way. A Structure does not have a refcount because it usually is part of a higher level object such as Caps, Message, Event, Query. It provides a means to enforce mutability using the refcount of the parent with the Structure::set_parent_refcount method.

A Structure can be created with Structure::new_empty or Structure::new, which both take a name and an optional set of key/value pairs along with the types of the values.

Field values can be changed with Structure::set_value or Structure::set.

Field values can be retrieved with Structure::get_value or the more convenient gst_structure_get_*() functions.

Fields can be removed with Structure::remove_field or Structure::remove_fields.

Strings in structures must be ASCII or UTF-8 encoded. Other encodings are not allowed. Strings may be None however.

Be aware that the current Caps / Structure serialization into string has limited support for nested Caps / Structure fields. It can only support one level of nesting. Using more levels will lead to unexpected behavior when using serialization features, such as Caps::to_string or gst_value_serialize and their counterparts.

Methods

impl Structure

pub fn builder(name: &str) -> Builder

pub fn new_empty(name: &str) -> Structure

Creates a new, empty Structure with the given name.

See Structure::set_name for constraints on the name parameter.

Free-function: gst_structure_free

name

name of new structure

Returns

a new, empty Structure

pub fn new(name: &str, values: &[(&str, &dyn ToSendValue)]) -> Structure

Creates a new Structure with the given name. Parses the list of variable arguments and sets fields to the values listed. Variable arguments should be passed as field name, field type, and value. Last variable argument should be None.

Free-function: gst_structure_free

name

name of new structure

firstfield

name of first field to set

Returns

a new Structure

pub unsafe fn into_ptr(self) -> *mut GstStructure

Methods from Deref<Target = StructureRef>

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

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

pub fn get<'structure, 'name, T: FromValueOptional<'structure>>(
    &'structure self,
    name: &'name str
) -> Result<Option<T>, GetError<'name>>

pub fn get_optional<'structure, 'name, T: FromValueOptional<'structure>>(
    &'structure self,
    name: &'name str
) -> Result<Option<T>, GetError<'name>>

pub fn get_some<'structure, 'name, T: FromValue<'structure>>(
    &'structure self,
    name: &'name str
) -> Result<T, GetError<'name>>

pub fn get_value<'structure, 'name>(
    &'structure self,
    name: &'name str
) -> Result<&SendValue, GetError<'name>>

pub fn set<T: ToSendValue>(&mut self, name: &str, value: &T)

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

pub fn get_name(&self) -> &str

pub fn set_name(&mut self, name: &str)

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

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

pub fn remove_field(&mut self, field: &str)

pub fn remove_fields(&mut self, fields: &[&str])

pub fn remove_all_fields(&mut self)

pub fn fields(&self) -> FieldIterator

pub fn iter(&self) -> Iter

pub fn get_nth_field_name(&self, idx: u32) -> Option<&str>

pub fn n_fields(&self) -> u32

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: &str) -> bool

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

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

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

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

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

Trait Implementations

impl AsMut<StructureRef> for Structure

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

Performs the conversion.

impl AsRef<StructureRef> for Structure

fn as_ref(&self) -> &StructureRef

Performs the conversion.

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 Clone for Structure

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 Structure

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

Formats the value using the given formatter.

impl Deref for Structure

type Target = StructureRef

The resulting type after dereferencing.

fn deref(&self) -> &StructureRef

Dereferences the value.

impl DerefMut for Structure

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

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Structure

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

Deserialize this value from the given Serde deserializer.

impl Display for Structure

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

Formats the value using the given formatter.

impl Drop for Structure

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Structure

impl FromGlibPtrFull<*const GstStructure> for Structure

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

impl FromGlibPtrFull<*mut GstStructure> for Structure

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

impl FromGlibPtrNone<*const GstStructure> for Structure

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

impl FromGlibPtrNone<*mut GstStructure> for Structure

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

impl FromStr for Structure

type Err = BoolError

The associated error which can be returned from parsing.

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

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

impl<'a> FromValueOptional<'a> for Structure

unsafe fn from_value_optional(v: &'a Value) -> Option<Self>

impl GlibPtrDefault for Structure

type GlibType = *mut GstStructure

impl PartialEq<Structure> for Structure

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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 ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Send for Structure

impl Serialize for Structure

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

Serialize this value into the given Serde serializer.

impl SetValue for Structure

unsafe fn set_value(v: &mut Value, s: &Self)

impl SetValueOptional for Structure

unsafe fn set_value_optional(v: &mut Value, s: Option<&Self>)

impl StaticType for Structure

fn static_type() -> Type

Returns the type identifier of Self.

impl Sync for Structure

impl<'a> ToGlibPtr<'a, *const GstStructure> for Structure

type Storage = &'a Self

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

Transfer: none.

fn to_glib_full(&self) -> *const GstStructure

Transfer: full.

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

Transfer: container.

impl<'a> ToGlibPtr<'a, *mut GstStructure> for Structure

type Storage = &'a Self

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

Transfer: none.

fn to_glib_full(&self) -> *mut GstStructure

Transfer: full.

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

Transfer: container.

impl<'a> ToGlibPtrMut<'a, *mut GstStructure> for Structure

type Storage = &'a mut Self

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

Transfer: none.