Struct libpulse_binding::proplist::Proplist

pub struct Proplist {
    pub ptr: *mut ProplistInternal,
    // some fields omitted
}

A property list object. Basically a dictionary with ASCII strings as keys and arbitrary data as values. This acts as a safe Rust wrapper for the actual C object.

Fields

ptr: *mut ProplistInternal

The actual C object.

Methods

impl Proplist

fn new() -> Option<Self>

Allocate a property list.

fn new_from_string(s: &str) -> Option<Self>

Allocate a new property list and assign key/value from a human readable string.

fn from_raw(ptr: *mut ProplistInternal) -> Self

Create a new Proplist from an existing ProplistInternal pointer.

fn from_raw_weak(ptr: *mut ProplistInternal) -> Self

Create a new Proplist from an existing ProplistInternal pointer. This is the 'weak' version, for use in callbacks, which avoids destroying the internal object when dropped.

fn key_is_valid(key: &str) -> bool

Returns true if the key is valid.

fn sets(&self, key: &str, value: &str) -> Result<(), ()>

Append a new string entry to the property list, possibly overwriting an already existing entry with the same key. An internal copy is made of the provided string.

fn setp(&self, pair: &str) -> Result<(), ()>

Append a new string entry to the property list, possibly overwriting an already existing entry with the same key.

This is similar to sets, however here the provided key and value are combined into a single string, separated by an =. An internal copy is made of the provided string.

fn set(&self, key: &str, data: &[u8]) -> Result<(), ()>

Append a new arbitrary data entry to the property list, possibly overwriting an already existing entry with the same key. An internal copy of the provided data is made.

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

Return a string entry for the specified key. Will return None if the key does not exist or if data is not valid UTF-8.

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

Get the value for the specified key.

For string entries, the value store will be NUL-terminated. The caller should make a copy of the data before the property list is accessed again.

Returns a slice formed from the data pointer and the length of the data. Returns None if key does not exist.

fn merge(&self, other: &Self, mode: UpdateMode)

Merge property list "other" into self, adhering to the merge mode specified.

fn unset(&self, key: &str) -> Result<(), i32>

Removes a single entry from the property list, identified by the specified key name.

fn unset_many(&self, keys: &[&str]) -> Option<u32>

Similar to unset but takes an array of keys to remove.

Returns None on failure, otherwise the number of entries actually removed (which might even be 0, if there were no matching entries to remove).

fn iterate(&self) -> Option<String>

Used for iterating through the property list.

This function should be called in a loop until it returns None which signifies EOL. On each loop, the key of an entry is returned. The property list should not be modified during iteration through the list, with the exception of deleting the current entry. The keys in the property list do not have any particular order.

while let Some(key) = my_props.iterate() {
    //do something with it
}

fn to_string(&self) -> Option<String>

Format the property list nicely as a human readable string.

This works very much like to_string_sep and uses a newline as separator and appends one final one.

fn to_string_sep(&self, sep: &str) -> Option<String>

Format the property list nicely as a human readable string, choosing the separator used.

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

Returns true if an entry for the specified key exists in the property list. Returns None on error.

fn clear(&self)

Remove all entries from the property list object.

fn len(&self) -> u32

Returns the number of entries in the property list.

fn is_empty(&self) -> bool

Returns true when the proplist is empty, false otherwise

fn equal_to(&self, to: &Self) -> bool

Returns true when self and to have the same keys and values.

Trait Implementations

impl Drop for Proplist

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Proplist

fn clone(&self) -> Self

Allocate a new property list and copy over every single entry from the specified list. If this is called on a 'weak' instance, a non-weak object is returned.

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

Performs copy-assignment from source.