Struct PropertiesBox

pub struct PropertiesBox { /* private fields */ }

Smart pointer providing unique ownership of a PipeWire properties object.

For an explanation of these, see Smart pointers to PipeWire objects.

Examples

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

use pipewire::{properties::{properties, PropertiesBox}};

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

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

Implementations

impl PropertiesBox

pub fn new() -> Self

Create a new, initially empty Properties struct.

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

Take ownership of an existing raw pw_properties pointer.

Safety

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

pub fn into_raw(self) -> *mut pw_properties

Give up ownership of the contained properties , 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(dict: &DictRef) -> Self

Create a new Properties from a given dictionary.

All the keys and values from dict are copied.

Methods from Deref<Target = Properties>

pub fn as_raw(&self) -> &pw_properties

pub fn as_raw_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.

pub fn dict(&self) -> &DictRef

pub fn to_owned(&self) -> PropertiesBox

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

pub fn insert<K, V>(&mut self, key: K, value: V)

where K: Into<Vec<u8>>, V: Into<Vec<u8>>,

pub fn remove<T>(&mut self, key: T)

where T: Into<Vec<u8>>,

pub fn clear(&mut self)

Trait Implementations

impl AsRef<DictRef> for PropertiesBox

fn as_ref(&self) -> &DictRef

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

impl AsRef<Properties> for PropertiesBox

fn as_ref(&self) -> &Properties

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

impl Clone for PropertiesBox

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropertiesBox

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

Formats the value using the given formatter.

impl Default for PropertiesBox

fn default() -> Self

Returns the “default value” for a type.

impl Deref for PropertiesBox

type Target = Properties

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for PropertiesBox

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

Mutably dereferences the value.

impl Drop for PropertiesBox

fn drop(&mut self)

Executes the destructor for this type.