Struct dbus::strings::Path

pub struct Path<'a>(_);

A wrapper around a string that is guaranteed to be a valid D-Bus object path.

Methods

impl<'m> Path<'m>

pub fn new<S: Into<Vec<u8>>>(s: S) -> Result<Path<'m>, String>

Creates a new instance of this struct.

Note: If the no-string-validation feature is activated, this string will not be checked for conformance with the D-Bus specification.

pub fn from_slice(s: &'m [u8]) -> Result<Path<'m>, String>

Creates a new instance of this struct. If you end it with \0, it can borrow the slice without extra allocation.

Note: If the no-string-validation feature is activated, this string will not be checked for conformance with the D-Bus specification.

pub unsafe fn from_slice_unchecked(s: &'m [u8]) -> Path<'m>

This function creates a new instance of this struct, without checking. It's up to you to guarantee that s ends with a \0 and is valid.

pub fn as_cstr(&self) -> &CStr

View this struct as a CStr.

pub fn into_static(self) -> Path<'static>

Makes sure this string does not contain borrows.

pub fn into_cstring(self) -> CString

Converts this struct to a CString.

Trait Implementations

impl<'a> Append for Path<'a>

fn append_by_ref(&self, i: &mut IterAppend)

Performs the append operation by borrowing self.

fn append(self, ia: &mut IterAppend) where
    Self: Sized, 

Performs the append operation by consuming self.

impl<'a> Arg for Path<'a>

const ARG_TYPE: ArgType

The corresponding D-Bus argument type code.

fn signature() -> Signature<'static>

The corresponding D-Bus type signature for this type.

impl<'m> AsRef<CStr> for Path<'m>

fn as_ref(&self) -> &CStr

Performs the conversion.

impl<'a> Clone for Path<'a>

fn clone(&self) -> Path<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Path<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Path<'a>

fn default() -> Path<'a>

Returns the "default value" for a type.

impl<'m> Deref for Path<'m>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<'a> DictKey for Path<'a>

impl<'m> Display for Path<'m>

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

Formats the value using the given formatter.

impl<'a> Eq for Path<'a>

impl<'m> From<&'m CStr> for Path<'m>

#Panics

If given string is not valid.

fn from(s: &'m CStr) -> Path<'m>

Performs the conversion.

impl<'inner, 'm: 'inner> From<&'m Path<'inner>> for Path<'m>

fn from(borrow: &'m Path<'inner>) -> Path<'m>

Performs the conversion.

impl<'m> From<&'m String> for Path<'m>

#Panics

If given string is not valid.

fn from(s: &'m String) -> Path<'m>

Performs the conversion.

impl<'m> From<&'m str> for Path<'m>

#Panics

If given string is not valid.

fn from(s: &'m str) -> Path<'m>

Performs the conversion.

impl<'m> From<Cow<'m, str>> for Path<'m>

#Panics

If given string is not valid.

fn from(s: Cow<'m, str>) -> Path<'m>

Performs the conversion.

impl<'m> From<Path<'m>> for CString

fn from(s: Path<'m>) -> CString

Performs the conversion.

impl From<Path<'static>> for MessageItem

fn from(i: Path<'static>) -> MessageItem

Performs the conversion.

impl<'m> From<String> for Path<'m>

#Panics

If given string is not valid.

fn from(s: String) -> Path<'m>

Performs the conversion.

impl<'a> Get<'a> for Path<'static>

fn get(i: &mut Iter<'a>) -> Option<Path<'static>>

Performs the get operation.

impl<'m> Hash for Path<'m>

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, 

Feeds a slice of this type into the given [Hasher].

impl<'a> Ord for Path<'a>

fn cmp(&self, other: &Path<'a>) -> Ordering

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> PartialEq<Path<'a>> for Path<'a>

fn eq(&self, other: &Path<'a>) -> bool

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

fn ne(&self, other: &Path<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<Path<'a>> for Path<'a>

fn partial_cmp(&self, other: &Path<'a>) -> Option<Ordering>

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

fn lt(&self, other: &Path<'a>) -> bool

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

fn le(&self, other: &Path<'a>) -> bool

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

fn gt(&self, other: &Path<'a>) -> bool

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

fn ge(&self, other: &Path<'a>) -> bool

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

impl RefArg for Path<'static>

fn arg_type(&self) -> ArgType

The corresponding D-Bus argument type code.

fn signature(&self) -> Signature<'static>

The corresponding D-Bus type signature for this type.

fn append(&self, i: &mut IterAppend)

Performs the append operation.

fn as_any(&self) -> &dyn Any

Transforms this argument to Any (which can be downcasted to read the current value).

fn as_any_mut(&mut self) -> &mut dyn Any

Transforms this argument to Any (which can be downcasted to read the current value).

fn as_str(&self) -> Option<&str>

Try to read the argument as a str.

fn box_clone(&self) -> Box<dyn RefArg + 'static>

Deep clone of the RefArg, causing the result to be 'static.

fn as_i64(&self) -> Option<i64>

Try to read the argument as an i64.

fn as_u64(&self) -> Option<u64>

Try to read the argument as an u64.

fn as_f64(&self) -> Option<f64>

Try to read the argument as an f64.

fn as_iter<'a>(
    &'a self
) -> Option<Box<dyn Iterator<Item = &'a dyn RefArg> + 'a>>

Try to read the argument as an iterator.

impl<'a> StructuralEq for Path<'a>

impl<'a> StructuralPartialEq for Path<'a>

impl<'a> TryFrom<&'a MessageItem> for &'a Path<'static>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a Path<'static>, ()>

Performs the conversion.