Struct ObjectPathBuf 

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

A validated owned object path.

The following rules define a valid object path. Implementations must not send or accept messages with invalid object paths.

• The path may be of any length.
• The path must begin with an ASCII ‘/’ (integer 47) character, and must consist of elements separated by slash characters.
• Each element must only contain the ASCII characters [A-Z][a-z][0-9]_
• No element may be the empty string.
• Multiple ‘/’ characters cannot occur in sequence.
• A trailing ‘/’ character is not allowed unless the path is the root path (a single ‘/’ character).

Methods from Deref<Target = ObjectPath>

pub const ROOT: &'static Self

pub fn iter(&self) -> Iter<'_>

Construct an iterator over the object path.

Examples

use tokio_dbus::ObjectPath;

let mut it = ObjectPath::new_const(b"/").iter();
assert!(it.next().is_none());

let mut it = ObjectPath::new_const(b"/foo").iter();
assert_eq!(it.next(), Some("foo"));
assert!(it.next().is_none());

let mut it = ObjectPath::new_const(b"/foo/bar").iter();
assert_eq!(it.next_back(), Some("bar"));
assert_eq!(it.next(), Some("foo"));
assert!(it.next().is_none());

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

Test if one part starts with another.

Examples

use tokio_dbus::ObjectPath;

const FOO: &ObjectPath = ObjectPath::new_const(b"/foo");
const FOO_BAR: &ObjectPath = ObjectPath::new_const(b"/foo/bar");

assert!(FOO_BAR.starts_with(FOO));

Trait Implementations

impl AsRef<ObjectPath> for ObjectPathBuf

fn as_ref(&self) -> &ObjectPath

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

impl Borrow<ObjectPath> for ObjectPathBuf

fn borrow(&self) -> &ObjectPath

Immutably borrows from an owned value.

impl Clone for ObjectPathBuf

fn clone(&self) -> ObjectPathBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectPathBuf

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

Formats the value using the given formatter.

impl Deref for ObjectPathBuf

type Target = ObjectPath

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for ObjectPathBuf

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

Formats the value using the given formatter.

impl Eq for ObjectPathBuf

impl FromStr for ObjectPathBuf

Construct an owned object path by copying a string.

Examples

use tokio_dbus::{ObjectPath, ObjectPathBuf};

let path: ObjectPathBuf = "/org/freedesktop/DBus".parse()?;
assert_eq!(&*path, ObjectPath::new("/org/freedesktop/DBus")?);

type Err = ObjectPathError

The associated error which can be returned from parsing.

fn from_str(path: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ObjectPathBuf

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

where H: Hasher,

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 PartialEq for ObjectPathBuf

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ObjectPathBuf

impl TryFrom<String> for ObjectPathBuf

Construct an owned object path from a string, taking ownership of its allocation.

Examples

use tokio_dbus::{ObjectPath, ObjectPathBuf};

let path = ObjectPathBuf::try_from(String::from("/org/freedesktop/DBus"))?;
assert_eq!(&*path, ObjectPath::new("/org/freedesktop/DBus")?);

type Error = ObjectPathError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for ObjectPathBuf

Construct an owned object path from a vector, taking ownership of its allocation.

Examples

use tokio_dbus::{ObjectPath, ObjectPathBuf};

let path = ObjectPathBuf::try_from(b"/org/freedesktop/DBus".to_vec())?;
assert_eq!(&*path, ObjectPath::new("/org/freedesktop/DBus")?);

assert!(ObjectPathBuf::try_from(b"org/freedesktop/DBus".to_vec()).is_err());

type Error = ObjectPathError

The type returned in the event of a conversion error.

fn try_from(path: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.