Struct libpulse_binding::proplist::Proplist [−][src]
pub struct Proplist { /* fields omitted */ }
A property list object. Basically a dictionary with ASCII strings as keys and arbitrary data as values.
Methods
impl Proplist
[src]
impl Proplist
pub fn new() -> Option<Self>
[src]
pub fn new() -> Option<Self>
Allocate a property list.
pub fn new_from_string(s: &str) -> Option<Self>
[src]
pub fn new_from_string(s: &str) -> Option<Self>
Allocate a new property list and assign key/value from a human readable string.
pub fn key_is_valid(key: &str) -> bool
[src]
pub fn key_is_valid(key: &str) -> bool
Returns true
if the key is valid.
pub fn sets(&mut self, key: &str, value: &str) -> Result<(), ()>
[src]
pub fn sets(&mut 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.
pub fn setp(&mut self, pair: &str) -> Result<(), ()>
[src]
pub fn setp(&mut 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.
pub fn set(&mut self, key: &str, data: &[u8]) -> Result<(), ()>
[src]
pub fn set(&mut 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.
pub fn gets(&self, key: &str) -> Option<String>
[src]
pub 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.
pub fn get(&self, key: &str) -> Option<&[u8]>
[src]
pub 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.
pub fn merge(&mut self, other: &Self, mode: UpdateMode)
[src]
pub fn merge(&mut self, other: &Self, mode: UpdateMode)
Merge property list "other" into self, adhering to the merge mode specified.
pub fn unset(&mut self, key: &str) -> Result<(), PAErr>
[src]
pub fn unset(&mut self, key: &str) -> Result<(), PAErr>
Removes a single entry from the property list, identified by the specified key name.
pub fn unset_many(&mut self, keys: &[&str]) -> Option<u32>
[src]
pub fn unset_many(&mut 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).
ⓘImportant traits for Iteratorpub fn iter(&self) -> Iterator
[src]
pub fn iter(&self) -> Iterator
Get an immutable iterator over the list's keys.
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.
for key in my_props.iter() { //do something with it println!("key: {}", key); }
pub fn to_string(&self) -> Option<String>
[src]
pub 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.
pub fn to_string_sep(&self, sep: &str) -> Option<String>
[src]
pub fn to_string_sep(&self, sep: &str) -> Option<String>
Format the property list nicely as a human readable string, choosing the separator used.
pub fn contains(&self, key: &str) -> Option<bool>
[src]
pub 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.
pub fn clear(&mut self)
[src]
pub fn clear(&mut self)
Remove all entries from the property list object.
pub fn len(&self) -> u32
[src]
pub fn len(&self) -> u32
Returns the number of entries in the property list.
pub fn is_empty(&self) -> bool
[src]
pub fn is_empty(&self) -> bool
Returns true
when the proplist is empty, false otherwise
pub fn equal_to(&self, to: &Self) -> bool
[src]
pub fn equal_to(&self, to: &Self) -> bool
Returns true
when self and to
have the same keys and values.
Trait Implementations
impl Debug for Proplist
[src]
impl Debug for Proplist
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl IntoIterator for Proplist
[src]
impl IntoIterator for Proplist
type Item = String
The type of the elements being iterated over.
type IntoIter = Iterator
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
[src]
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
impl Drop for Proplist
[src]
impl Drop for Proplist
impl Clone for Proplist
[src]
impl Clone for Proplist