Struct dbus_message_parser::ObjectPath

pub struct ObjectPath(_);

This represents a object path.

Implementations

impl ObjectPath

pub fn append(&mut self, element: &str) -> bool

Append an element to the object path.

Returns true if the new element could be appended, otherwise false. An element cannot be appended if the element contain a character, which is not allowed.

Example

let mut object_path = ObjectPath::try_from("/object").unwrap();

assert!(object_path.append("path"));
assert!(!object_path.append("/path"));

assert_eq!(&object_path, "/object/path");

pub fn starts_with(&self, base: &ObjectPath) -> bool

Determines whether base is a prefix of self.

Example

let base = ObjectPath::try_from("/object").unwrap();

let path_1 = ObjectPath::try_from("/object/path").unwrap();
let path_2 = ObjectPath::try_from("/object_/path").unwrap();

assert!(path_1.starts_with(&base));
assert!(!path_2.starts_with(&base));
assert!(!base.starts_with(&base));

pub fn strip_prefix_elements<'a, 'b>(
    &'a self,
    base: &'b ObjectPath
) -> Option<Split<'a, char>>

Returns a Split object with the prefix removed.

Example

let base = ObjectPath::try_from("/object").unwrap();

let path_1 = ObjectPath::try_from("/object/path").unwrap();
let path_2 = ObjectPath::try_from("/object_/path").unwrap();
let path_3 = ObjectPath::try_from("/object/path/element").unwrap();

let path_1_base_vec: Vec<&str> = path_1.strip_prefix_elements(&base).unwrap().collect();
let path_3_base_vec: Vec<&str> = path_3.strip_prefix_elements(&base).unwrap().collect();

assert_eq!(path_1_base_vec, vec!["path"]);
assert!(path_2.strip_prefix_elements(&base).is_none());
assert_eq!(path_3_base_vec, vec!["path", "element"]);
assert!(base.strip_prefix_elements(&base).is_none());

Methods from Deref<Target = String>

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire String.

Examples

Basic usage:

let s = String::from("foo");

assert_eq!("foo", s.as_str());

pub fn capacity(&self) -> usize

Returns this String's capacity, in bytes.

Examples

Basic usage:

let s = String::with_capacity(10);

assert!(s.capacity() >= 10);

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice of this String's contents.

The inverse of this method is from_utf8.

Examples

Basic usage:

let s = String::from("hello");

assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());

pub fn len(&self) -> usize

Returns the length of this String, in bytes, not chars or graphemes. In other words, it may not be what a human considers the length of the string.

Examples

Basic usage:

let a = String::from("foo");
assert_eq!(a.len(), 3);

let fancy_f = String::from("ƒoo");
assert_eq!(fancy_f.len(), 4);
assert_eq!(fancy_f.chars().count(), 3);

pub fn is_empty(&self) -> bool

Returns true if this String has a length of zero, and false otherwise.

Examples

Basic usage:

let mut v = String::new();
assert!(v.is_empty());

v.push('a');
assert!(!v.is_empty());

Trait Implementations

impl Clone for ObjectPath

pub fn clone(&self) -> ObjectPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectPath

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

Formats the value using the given formatter.

impl Default for ObjectPath

pub fn default() -> Self

Returns the "default value" for a type.

impl Deref for ObjectPath

type Target = String

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for ObjectPath

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

Formats the value using the given formatter.

impl Eq for ObjectPath

impl From<ObjectPath> for String

pub fn from(object_path: ObjectPath) -> Self

Performs the conversion.

impl Hash for ObjectPath

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for ObjectPath

pub fn cmp(&self, other: &ObjectPath) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ObjectPath> for ObjectPath

pub fn eq(&self, other: &ObjectPath) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<str> for ObjectPath

pub fn eq(&self, other: &str) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ObjectPath> for ObjectPath

pub fn partial_cmp(&self, other: &ObjectPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &ObjectPath) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &ObjectPath) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &ObjectPath) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &ObjectPath) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ObjectPath

impl StructuralPartialEq for ObjectPath

impl<'_> TryFrom<&'_ str> for ObjectPath

type Error = ObjectPathError

The type returned in the event of a conversion error.

pub fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for ObjectPath

type Error = ObjectPathError

The type returned in the event of a conversion error.

pub fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.