Struct zvariant::ObjectPath

pub struct ObjectPath(_);

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

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

Methods

impl ObjectPath

pub fn new(path: impl Into<ObjectPath>) -> Self

Create a new ObjectPath.

pub fn as_str(&self) -> &str

The object path as a string.

Trait Implementations

impl Basic for ObjectPath

impl Clone for ObjectPath

fn clone(&self) -> ObjectPath

Returns a copy 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 Decode for ObjectPath

fn slice_data<'b>(
    data: impl Into<SharedData>,
    signature: impl Into<Signature>,
    format: EncodingFormat
) -> Result<SharedData, VariantError>

Get the slice of data that belongs to implementing type.

fn decode(
    data: impl Into<SharedData>,
    signature: impl Into<Signature>,
    format: EncodingFormat
) -> Result<Self, VariantError>

Decode instance of implementing type from the data slice.

fn take_from_variant(variant: Variant) -> Result<Self, VariantError>

Flatten the variant to enclosed value of the implementing type.

fn from_variant(variant: &Variant) -> Result<&Self, VariantError>

Flatten the variant reference to a reference of the enclosed value of the implementing type.

fn ensure_correct_signature(
    signature: impl Into<Signature>
) -> Result<Signature, VariantError>

Ensure given signature is correct and of the implementing type.

fn slice_signature(
    signature: impl Into<Signature>
) -> Result<Signature, VariantError>

Get the slice of signature that belongs to implementing type.

fn slice_for_decoding(
    data: impl Into<SharedData>,
    signature: impl Into<Signature>,
    format: EncodingFormat
) -> Result<SharedData, VariantError>

A helper for [decode] implementation. Removes any leading padding bytes.

impl Deref for ObjectPath

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl Encode for ObjectPath

const SIGNATURE_CHAR: char

The signature charachter of the implementing type.

const SIGNATURE_STR: &'static str

The signature charachter of the implementing type, in string format.

const ALIGNMENT: usize

The alignment required for encoding of the implementing type, as number of bytes.

fn encode_into(&self, bytes: &mut Vec<u8>, format: EncodingFormat)

Encode self and append to the end of bytes buffer.

fn to_variant(self) -> Variant

Unflatten self into a [Variant].

fn is(variant: &Variant) -> bool

Checks if variant value is of the generic type T.

fn encode(&self, format: EncodingFormat) -> Vec<u8>

Encode self into a new byte buffer and return it.

fn signature(&self) -> Signature

Get the signature.

fn add_padding(bytes: &mut Vec<u8>, format: EncodingFormat)

Append required padding to bytes buffer.

fn padding(n_bytes_before: usize, _format: EncodingFormat) -> usize

The required padding for the implementing type.

impl Eq for ObjectPath

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

fn from(value: &str) -> Self

Performs the conversion.

impl From<String> for ObjectPath

fn from(value: String) -> Self

Performs the conversion.

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, 

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

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

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

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

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

This method tests for !=.

impl PartialEq<ObjectPath> for ObjectPath

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

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

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

This method tests for !=.

impl SimpleDecode for ObjectPath

fn slice_data_simple(
    data: impl Into<SharedData>,
    format: EncodingFormat
) -> Result<SharedData, VariantError> where
    Self: Sized, 

Same as [Decode::slice_data], except you don't have to pass any signature to it.

fn decode_simple(
    data: impl Into<SharedData>,
    format: EncodingFormat
) -> Result<Self, VariantError> where
    Self: Sized, 

Same as [Decode::decode], except you don't have to pass any signature to it.

impl StructuralEq for ObjectPath

impl StructuralPartialEq for ObjectPath