Struct ObjectPath

pub struct ObjectPath(/* private fields */);

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());

Trait Implementations

impl AsRef<str> for ObjectPath

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ObjectPath

fn clone(&self) -> ObjectPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectPath

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

Formats the value using the given formatter.

impl Default for ObjectPath

fn default() -> Self

Returns the “default value” for a type.

impl Display for ObjectPath

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

Formats the value using the given formatter.

impl From<ObjectPath> for String

fn from(object_path: ObjectPath) -> Self

Converts to this type from the input type.

impl Hash for ObjectPath

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 Ord for ObjectPath

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<str> for ObjectPath

fn eq(&self, other: &str) -> 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 PartialEq for ObjectPath

fn eq(&self, other: &ObjectPath) -> 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 PartialOrd for ObjectPath

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&[u8]> for ObjectPath

type Error = ObjectPathError

The type returned in the event of a conversion error.

fn try_from(object_path: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for ObjectPath

type Error = ObjectPathError

The type returned in the event of a conversion error.

fn try_from(object_path: &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.

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

Performs the conversion.

impl Eq for ObjectPath

impl StructuralPartialEq for ObjectPath