Struct wireplumber::pw::Properties

pub struct Properties { /* private fields */ }

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl Properties

pub fn as_ptr(&self) -> *mut WpProperties

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow<'a>( ptr: *const *const WpProperties ) -> &'a Self

Borrows the underlying C value.

impl Properties

pub fn new() -> Properties

pub fn new_string(str: &str) -> Properties

pub fn add(&self, props: &Properties) -> i32

pub fn add_keys(&self, props: &Properties, keys: &[&str]) -> i32

pub fn copy(&self) -> Option<Properties>

pub fn ensure_unique_owner(self) -> Option<Properties>

pub fn get(&self, key: &str) -> Option<GString>

pub fn count(&self) -> u32

Available on crate feature v0_4_10 only.

pub fn matches(&self, other: &Properties) -> bool

pub fn set(&self, key: &str, value: Option<&str>) -> i32

pub fn sort(&self)

pub fn update(&self, props: &Properties) -> i32

pub fn update_keys(&self, props: &Properties, keys: &[&str]) -> i32

pub fn iterator_item_get_key(item: &Value) -> Option<GString>

pub fn iterator_item_get_value(item: &Value) -> Option<GString>

impl Properties

pub fn new_clone(props: &Self) -> Properties

pub unsafe fn new_copy(props: &pw_properties) -> Properties

pub unsafe fn new_copy_dict(dict: &spa_dict) -> Properties

pub unsafe fn new_wrap(props: *const pw_properties) -> Properties

pub unsafe fn new_wrap_mut(props: *mut pw_properties) -> Properties

pub unsafe fn new_wrap_dict(dict: *const spa_dict) -> Properties

pub unsafe fn add_from_dict(&self, dict: &spa_dict) -> usize

pub fn peek_dict(&self) -> &spa_dict

pub fn to_pw_properties(&self) -> NonNull<pw_properties>

pub fn unref_and_take_pw_properties(self) -> NonNull<pw_properties>

pub unsafe fn update_from_dict(&self, dict: &spa_dict) -> usize

pub fn remove(&self, key: &str) -> bool

pub fn insert<V: ToPipewirePropertyString>(&self, key: &str, value: V)

pub fn iter( &self ) -> Map<ValueIterator<PropertiesItem>, fn(_: PropertiesItem) -> (String, String)>

pub fn items(&self) -> IntoValueIterator<PropertiesItem>

pub fn keys(&self) -> impl Iterator<Item = String>

pub fn values(&self) -> impl Iterator<Item = String>

Trait Implementations

impl Clone for Properties

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for Properties

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

Formats the value using the given formatter.

impl Default for Properties

fn default() -> Self

Returns the “default value” for a type.

impl<K: AsRef<str>, V: ToPipewirePropertyString> Extend<(K, V)> for Properties

fn extend<T: IntoIterator<Item = (K, V)>>(&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 From<Properties> for Value

fn from(s: Properties) -> Self

Converts to this type from the input type.

impl FromIterator<(String, String)> for Properties

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

Creates a value from an iterator.

impl HasParamSpec for Properties

type ParamSpec = ParamSpecBoxed

type SetValue = Properties

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Properties

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a Properties

type Item = (String, String)

The type of the elements being iterated over.

type IntoIter = Map<ValueIterator<PropertiesItem>, fn(_: PropertiesItem) -> <&'a Properties as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Properties

type Item = (String, String)

The type of the elements being iterated over.

type IntoIter = Map<ValueIterator<PropertiesItem>, fn(_: PropertiesItem) -> <Properties as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Properties

fn cmp(&self, other: &Properties) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Properties

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

fn partial_cmp(&self, other: &Properties) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Properties

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Properties

impl StructuralPartialEq for Properties