Struct zvariant::ObjectPath

pub struct ObjectPath<'a>(_);

String that identifies objects at a given destination on the D-Bus bus.

Mostly likely this is only useful in the D-Bus context.

Examples

use core::convert::TryFrom;
use zvariant::ObjectPath;

// Valid object paths
let o = ObjectPath::try_from("/").unwrap();
assert_eq!(o, "/");
let o = ObjectPath::try_from("/Path/t0/0bject").unwrap();
assert_eq!(o, "/Path/t0/0bject");
let o = ObjectPath::try_from("/a/very/looooooooooooooooooooooooo0000o0ng/path").unwrap();
assert_eq!(o, "/a/very/looooooooooooooooooooooooo0000o0ng/path");

// Invalid object paths
ObjectPath::try_from("").unwrap_err();
ObjectPath::try_from("/double//slashes/").unwrap_err();
ObjectPath::try_from(".").unwrap_err();
ObjectPath::try_from("/end/with/slash/").unwrap_err();
ObjectPath::try_from("/ha.d").unwrap_err();

Implementations

impl<'a> ObjectPath<'a>

pub fn as_str(&self) -> &str

The object path as a string.

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

The object path as bytes.

pub fn from_bytes_unchecked<'s: 'a>(bytes: &'s [u8]) -> Self

Create a new ObjectPath from given bytes.

Since the passed bytes are not checked for correctness, prefer using the TryFrom<&[u8]> implementation.

pub fn from_str_unchecked<'s: 'a>(path: &'s str) -> Self

Create a new ObjectPath from the given string.

Since the passed string is not checked for correctness, prefer using the TryFrom<&str> implementation.

pub fn from_string_unchecked(path: String) -> Self

Same as from_str_unchecked, except it takes an owned String.

Since the passed string is not checked for correctness, prefer using the TryFrom<String> implementation.

pub fn len(&self) -> usize

the object path’s length.

pub fn is_empty(&self) -> bool

if the object path is empty.

pub fn to_owned(&self) -> ObjectPath<'static>

Creates an owned clone of self.

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

Creates an owned clone of self.

Trait Implementations

impl<'a> Basic for ObjectPath<'a>

const SIGNATURE_CHAR: char

The type signature, as a character.

const SIGNATURE_STR: &'static str

The type signature, as a string.

const ALIGNMENT: usize

👎 Deprecated since 2.0.2:

Please use the alignment function instead

The required padding alignment.

fn alignment(format: EncodingFormat) -> usize

The required padding alignment for the given format.

impl<'a> Clone for ObjectPath<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ObjectPath<'a>

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<'a> Deref for ObjectPath<'a>

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de: 'a, 'a> Deserialize<'de> for ObjectPath<'a>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> Display for ObjectPath<'a>

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

Formats the value using the given formatter.

impl<'o> From<&'_ ObjectPath<'o>> for ObjectPath<'o>

fn from(o: &ObjectPath<'o>) -> Self

Performs the conversion.

impl<'a> From<&'a ObjectPath<'a>> for Value<'a>

fn from(v: &'a ObjectPath<'a>) -> Self

Performs the conversion.

impl<'unowned, 'owned: 'unowned> From<&'owned OwnedObjectPath> for ObjectPath<'unowned>

fn from(o: &'owned OwnedObjectPath) -> Self

Performs the conversion.

impl<'a> From<ObjectPath<'a>> for OwnedObjectPath

fn from(o: ObjectPath<'a>) -> Self

Performs the conversion.

impl<'a> From<ObjectPath<'a>> for Value<'a>

fn from(v: ObjectPath<'a>) -> Self

Performs the conversion.

impl<'a> From<ObjectPath<'a>> for OwnedValue

fn from(v: ObjectPath<'a>) -> Self

Performs the conversion.

impl From<OwnedObjectPath> for ObjectPath<'static>

fn from(o: OwnedObjectPath) -> Self

Performs the conversion.

impl<'a> Hash for ObjectPath<'a>

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> PartialEq<&'_ str> for ObjectPath<'a>

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

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

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

This method tests for !=.

impl<'a> PartialEq<ObjectPath<'a>> for ObjectPath<'a>

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

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

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

This method tests for !=.

impl<'a> PartialEq<str> for ObjectPath<'a>

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

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

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

This method tests for !=.

impl<'a> Serialize for ObjectPath<'a>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a [u8]> for ObjectPath<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a [u8]) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<&'a OwnedValue> for &'a ObjectPath<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: &'a OwnedValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Value<'a>> for &'a ObjectPath<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a Value<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Value<'a>> for ObjectPath<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a Value<'_>) -> Result<Self, Self::Error>

Performs the conversion.

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

Try to create an ObjectPath from a string.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<OwnedValue> for ObjectPath<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: OwnedValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<String> for ObjectPath<'a>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for ObjectPath<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Type for ObjectPath<'a>

fn signature() -> Signature<'static>

Get the signature for the implementing type.

impl<'a> Eq for ObjectPath<'a>

impl<'a> StructuralEq for ObjectPath<'a>

impl<'a> StructuralPartialEq for ObjectPath<'a>