Struct pipewire::PropertiesRef

pub struct PropertiesRef<'a> { /* fields omitted */ }

Implementations

impl<'a> PropertiesRef<'a>

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

Create a PropertiesRef struct from an existing raw pw_properties pointer.

Safety

• The provided pointer must point to a valid, well-aligned pw_properties struct.
• The generated PropertiesRef will not take ownership of the pointer so the pw_properties struct has to stays alive during all its lifetime.

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 PropertiesRef 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 to_owned(&self) -> Properties

Trait Implementations

impl<'a> Debug for PropertiesRef<'a>

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

Formats the value using the given formatter.

impl<'a> ReadableDict for PropertiesRef<'a>

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.