Struct pipewire::Properties

pub struct Properties { /* fields omitted */ }

A collection of key/value pairs.

Examples

Create a Properties struct and access the stored values by key:

use pipewire::prelude::*;
use pipewire::{properties, Properties};

let props = properties!{
    "Key" => "Value",
    "OtherKey" => "OtherValue"
};

assert_eq!(Some("Value"), props.get("Key"));
assert_eq!(Some("OtherValue"), props.get("OtherKey"));

Implementations

impl Properties

pub unsafe fn from_ptr(ptr: NonNull<pw_properties>) -> Self

Create a Properties struct from an existing raw pw_properties pointer.

Safety

• The provided pointer must point to a valid, well-aligned pw_properties struct.
• After this call, the generated Properties struct will assume ownership of the data pointed to, so that data must not be freed elsewhere.

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

Obtain a pointer to the underlying pw_properties struct.

The pointer is only valid for the lifetime of the Properties struct the pointer was obtained from, and must not be dereferenced after it is dropped.

Ownership of the pw_properties struct is not transferred to the caller and must not be manually freed. If you want to take ownership, use into_raw() instead.

pub fn into_raw(self) -> *mut pw_properties

Consume the Properties struct, returning a pointer to the raw pw_properties struct.

After this function, the caller is responsible for pw_properties struct, and should make sure it is freed when it is no longer needed.

pub fn from_dict<D: ReadableDict>(dict: &D) -> Self

Create a new Properties from a given dictionary.

All the keys and values from dict are copied.

Trait Implementations

impl Clone for Properties

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 Properties

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

Formats the value using the given formatter.

impl Drop for Properties

fn drop(&mut self)

Executes the destructor for this type.

impl ReadableDict for Properties

fn get_dict_ptr(&self) -> *const spa_dict

Obtain the pointer to the raw spa_dict struct.

fn iter_cstr(&self) -> CIter<'_>

An iterator over all raw key-value pairs. The iterator element type is (&CStr, &CStr).

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

An iterator over all key-value pairs that are valid utf-8. The iterator element type is (&str, &str).

fn keys(&self) -> Keys<'_>

An iterator over all keys that are valid utf-8. The iterator element type is &str.

fn values(&self) -> Values<'_>

An iterator over all values that are valid utf-8. The iterator element type is &str.

fn len(&self) -> usize

Returns the number of key-value-pairs in the dict. This is the number of all pairs, not only pairs that are valid-utf8.

fn is_empty(&self) -> bool

Returns true if the dict is empty, false if it is not.

fn flags(&self) -> Flags

Returns the bitflags that are set for the dict.

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

Get the value associated with the provided key.

fn parse<T>(&self, key: &str) -> Option<Result<T, ParseValueError>> where
    T: ParsableValue, 

Get the value associated with the provided key and convert it to a given type.

impl WritableDict for Properties

fn insert<T: Into<Vec<u8>>>(&mut self, key: T, value: T)

Insert the key-value pair, overwriting any old value.

fn remove<T: Into<Vec<u8>>>(&mut self, key: T)

Remove the key-value pair if it exists.

fn clear(&mut self)

Clear the object, removing all key-value pairs.