Struct zbus::fdo::AsyncPeerProxy

pub struct AsyncPeerProxy<'c>(_);

Asynchronous sibling of PeerProxy. Proxy for the org.freedesktop.DBus.Peer interface.

Implementations

impl<'c> AsyncPeerProxy<'c>

pub fn new(conn: &Connection) -> Result<Self>

Creates a new proxy with the default service & path.

pub fn new_owned(conn: Connection) -> Result<Self>

Creates a new proxy with the default service & path, taking ownership of conn.

pub fn new_for(
    conn: &Connection,
    destination: &'c str,
    path: impl TryInto<ObjectPath<'c>, Error = Error>
) -> Result<Self>

Creates a new proxy for the given destination and path.

pub fn new_for_owned(
    conn: Connection,
    destination: String,
    path: impl TryInto<ObjectPath<'static>, Error = Error>
) -> Result<Self>

Same as new_for but takes ownership of the passed arguments.

pub fn new_for_path(
    conn: &Connection,
    path: impl TryInto<ObjectPath<'c>, Error = Error>
) -> Result<Self>

Creates a new proxy for the given path.

pub fn new_for_owned_path(
    conn: Connection,
    path: impl TryInto<ObjectPath<'static>, Error = Error>
) -> Result<Self>

Same as new_for_path but takes ownership of the passed arguments.

pub fn into_inner(self) -> Proxy<'c>

Consumes self, returning the underlying zbus::Proxy.

pub fn inner(&self) -> &Proxy<'_>

The reference to the underlying zbus::Proxy.

pub async fn ping(&self) -> Result<()>

On receipt, an application should do nothing other than reply as usual. It does not matter which object path a ping is sent to.

pub async fn get_machine_id(&self) -> Result<String>

An application should reply the containing a hex-encoded UUID representing the identity of the machine the process is running on. This UUID must be the same for all processes on a single system at least until that system next reboots. It should be the same across reboots if possible, but this is not always possible to implement and is not guaranteed. It does not matter which object path a GetMachineId is sent to.

pub async fn introspect(&self) -> Result<String>

Methods from Deref<Target = Proxy<'c>>

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

pub fn destination(&self) -> &str

Get a reference to the destination service name.

pub fn path(&self) -> &ObjectPath<'_>

Get a reference to the object path.

pub fn interface(&self) -> &str

Get a reference to the interface.

pub async fn introspect(&self) -> Result<String>

Introspect the associated object, and return the XML description.

See the xml module for parsing the result.

pub async fn get_property<T>(&self, property_name: &str) -> Result<T> where
    T: TryFrom<OwnedValue>, 

Get the property property_name.

Effectively, call the Get method of the org.freedesktop.DBus.Properties interface.

pub async fn set_property<'t, T: 't>(
    &self,
    property_name: &str,
    value: T
) -> Result<()> where
    T: Into<Value<'t>>, 

Set the property property_name.

Effectively, call the Set method of the org.freedesktop.DBus.Properties interface.

pub async fn call_method<B>(
    &self,
    method_name: &str,
    body: &B
) -> Result<Message> where
    B: Serialize + Type, 

Call a method and return the reply.

Typically, you would want to use call method instead. Use this method if you need to deserialize the reply message manually (this way, you can avoid the memory allocation/copying, by deserializing the reply to an unowned type).

pub async fn call<B, R>(&self, method_name: &str, body: &B) -> Result<R> where
    B: Serialize + Type,
    R: DeserializeOwned + Type, 

Call a method and return the reply body.

Use call_method instead if you need to deserialize the reply manually/separately.

pub async fn receive_signal(
    &self,
    signal_name: &'static str
) -> Result<SignalStream<'a>>

Create a stream for signal named signal_name.

If the associated connnection is to a bus, a match rule is added for the signal on the bus so that the bus sends us the signals. Since this match rule needs to be removed when you're done with the stream, a synchronous D-Bus method call is made in the destructor of the stream. If you'd like to avoid this, you must close the stream explicitly, using the SignalStream::close method.

pub async fn connect_signal<H>(
    &self,
    signal_name: &'static str,
    handler: H
) -> Result<()> where
    H: FnMut(&'msg Message) -> BoxFuture<'msg, Result<()>> + Send + 'static, 

Register a handler for signal named signal_name.

Once a handler is successfully registered, call Self::next_signal to wait for the next signal to arrive and be handled by its registered handler.

If the associated connnection is to a bus, a match rule is added for the signal on the bus so that the bus sends us the signals.

Errors

This method can fail if addition of the relevant match rule on the bus fails. You can safely unwrap the Result if you're certain that associated connnection is not a bus connection.

pub async fn disconnect_signal(&self, signal_name: &'static str) -> Result<bool>

Deregister the handler for the signal named signal_name.

If the associated connnection is to a bus, the match rule is removed for the signal on the bus so that the bus stops sending us the signal. This method returns Ok(true) if a handler was registered for signal_name and was removed by this call; Ok(false) otherwise.

Errors

This method can fail if removal of the relevant match rule on the bus fails. You can safely unwrap the Result if you're certain that associated connnection is not a bus connection.

pub async fn next_signal(&self) -> Result<Option<Message>>

Receive and handle the next incoming signal on the associated connection.

This method will wait for signal messages on the associated connection and call any handlers registered through the Self::connect_signal method.

If the signal message was handled by a handler, Ok(None) is returned. Otherwise, the received message is returned.

pub async fn handle_signal(&self, msg: &Message) -> Result<bool>

Handle the provided signal message.

Call any handlers registered through the Self::connect_signal method for the provided signal message.

If no errors are encountered, Ok(true) is returned if a handler was found and called for, the signal; Ok(false) otherwise.

Trait Implementations

impl<'c> AsMut<Proxy<'c>> for AsyncPeerProxy<'c>

fn as_mut(&mut self) -> &mut Proxy<'c>

Performs the conversion.

impl<'c> AsRef<Proxy<'c>> for AsyncPeerProxy<'c>

fn as_ref(&self) -> &Proxy<'c>

Performs the conversion.

impl<'c> Debug for AsyncPeerProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for AsyncPeerProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for AsyncPeerProxy<'c>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.