Struct Parameters 

pub struct Parameters<'s>(/* private fields */);

A map of key/value (String,String) parameters. It can be parsed from a String, using ; or <newline> as separator between each parameters and = as separator between a key and its value. Keys and values are trimmed.

Example:

use zenoh_protocol::core::Parameters;

let a = "a=1;b=2;c=3|4|5;d=6";
let p = Parameters::from(a);

// Retrieve values
assert!(!p.is_empty());
assert_eq!(p.get("a").unwrap(), "1");
assert_eq!(p.get("b").unwrap(), "2");
assert_eq!(p.get("c").unwrap(), "3|4|5");
assert_eq!(p.get("d").unwrap(), "6");
assert_eq!(p.values("c").collect::<Vec<&str>>(), vec!["3", "4", "5"]);

// Iterate over parameters
let mut iter = p.iter();
assert_eq!(iter.next().unwrap(), ("a", "1"));
assert_eq!(iter.next().unwrap(), ("b", "2"));
assert_eq!(iter.next().unwrap(), ("c", "3|4|5"));
assert_eq!(iter.next().unwrap(), ("d", "6"));
assert!(iter.next().is_none());

// Create parameters from iterators
let pi = Parameters::from_iter(vec![("a", "1"), ("b", "2"), ("c", "3|4|5"), ("d", "6")]);
assert_eq!(p, pi);

Implementations

impl<'s> Parameters<'s>

pub const fn empty() -> Self

Create empty parameters.

pub fn is_empty(&self) -> bool

Returns true if parameters does not contain anything.

pub fn as_str(&'s self) -> &'s str

Returns parameters as str.

pub fn contains_key<K>(&self, k: K) -> bool

where K: Borrow<str>,

Returns true if parameters contains the specified key.

pub fn get<K>(&'s self, k: K) -> Option<&'s str>

where K: Borrow<str>,

Returns a reference to the &str-value corresponding to the key.

pub fn values<K>(&'s self, k: K) -> impl DoubleEndedIterator<Item = &'s str>

where K: Borrow<str>,

Returns an iterator to the &str-values corresponding to the key.

pub fn iter( &'s self, ) -> impl DoubleEndedIterator<Item = (&'s str, &'s str)> + Clone

Returns an iterator on the key-value pairs as (&str, &str).

pub fn insert<K, V>(&mut self, k: K, v: V) -> Option<String>

where K: Borrow<str>, V: Borrow<str>,

Inserts a key-value pair into the map. If the map did not have this key present, None` is returned. If the map did have this key present, the value is updated, and the old value is returned.

pub fn remove<K>(&mut self, k: K) -> Option<String>

where K: Borrow<str>,

Removes a key from the map, returning the value at the key if the key was previously in the parameters.

pub fn extend(&mut self, other: &Parameters<'_>)

Extend these parameters with other parameters.

pub fn extend_from_iter<'e, I, K, V>(&mut self, iter: I)

where I: Iterator<Item = (&'e K, &'e V)> + Clone, K: Borrow<str> + 'e + ?Sized, V: Borrow<str> + 'e + ?Sized,

Extend these parameters from an iterator.

pub fn into_owned(self) -> Parameters<'static>

Convert these parameters into owned parameters.

pub fn is_ordered(&self) -> bool

Returns `true`` if all keys are sorted in alphabetical order.

Trait Implementations

impl<'s> Clone for Parameters<'s>

fn clone(&self) -> Parameters<'s>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameters<'_>

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

Formats the value using the given formatter.

impl<'s> Default for Parameters<'s>

fn default() -> Parameters<'s>

Returns the “default value” for a type.

impl Display for Parameters<'_>

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

Formats the value using the given formatter.

impl<'s, K, V> From<&'s [(K, V)]> for Parameters<'_>

where K: Borrow<str> + 's, V: Borrow<str> + 's,

fn from(value: &'s [(K, V)]) -> Self

Converts to this type from the input type.

impl From<&Parameters<'_>> for HashMap<String, String>

fn from(props: &Parameters<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Parameters<'a>> for Cow<'a, Parameters<'a>>

fn from(props: &'a Parameters<'a>) -> Self

Converts to this type from the input type.

impl<'s> From<&'s Parameters<'s>> for HashMap<&'s str, &'s str>

fn from(props: &'s Parameters<'s>) -> Self

Converts to this type from the input type.

impl<'s> From<&'s Parameters<'s>> for HashMap<Cow<'s, str>, Cow<'s, str>>

fn from(props: &'s Parameters<'s>) -> Self

Converts to this type from the input type.

impl<'s> From<&'s str> for Parameters<'s>

fn from(value: &'s str) -> Self

Converts to this type from the input type.

impl<'s> From<Cow<'s, str>> for Parameters<'s>

fn from(value: Cow<'s, str>) -> Self

Converts to this type from the input type.

impl<K, V> From<HashMap<K, V>> for Parameters<'_>

where K: Borrow<str>, V: Borrow<str>,

fn from(map: HashMap<K, V>) -> Self

Converts to this type from the input type.

impl From<Parameters<'_>> for HashMap<String, String>

fn from(props: Parameters<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<Parameters<'a>> for Cow<'_, Parameters<'a>>

fn from(props: Parameters<'a>) -> Self

Converts to this type from the input type.

impl From<String> for Parameters<'_>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<'s, K, V> FromIterator<&'s (K, V)> for Parameters<'_>

where K: Borrow<str> + 's, V: Borrow<str> + 's,

fn from_iter<T: IntoIterator<Item = &'s (K, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<'s, K, V> FromIterator<(&'s K, &'s V)> for Parameters<'_>

where K: Borrow<str> + 's + ?Sized, V: Borrow<str> + 's + ?Sized,

fn from_iter<T: IntoIterator<Item = (&'s K, &'s V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<'s> Hash for Parameters<'s>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'s> PartialEq for Parameters<'s>

fn eq(&self, other: &Parameters<'s>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'s> Eq for Parameters<'s>

impl<'s> StructuralPartialEq for Parameters<'s>