Struct zbus::azync::Proxy

pub struct Proxy<'a> { /* fields omitted */ }

The asynchronous sibling of crate::Proxy.

This API is mostly the same as crate::Proxy, except it is asynchronous. One of the implications of asynchronous API is that apart from the signal handling through connecting and disconnecting handlers (using Proxy::connect_signal and Proxy::disconnect_signal methods), you can also receive signals through a stream using Proxy::receive_signal method.

Another implication of asynchronous API is that we do not need crate::SignalReceiver here. The futures crate provides API to combine futures and streams already.

Example

use std::result::Result;
use std::error::Error;
use async_io::block_on;
use zbus::azync::{Connection, Proxy};

fn main() -> Result<(), Box<dyn Error>> {
    block_on(run())
}

async fn run() -> Result<(), Box<dyn Error>> {
    let connection = Connection::new_session().await?;
    let p = Proxy::new(
        &connection,
        "org.freedesktop.DBus",
        "/org/freedesktop/DBus",
        "org.freedesktop.DBus",
    ).await?;
    // owned return value
    let _id: String = p.call("GetId", &()).await?;
    // borrowed return value
    let _id: &str = p.call_method("GetId", &()).await?.body()?;

    Ok(())
}

Note

It is recommended to use the dbus_proxy macro, which provides a more convenient and type-safe façade Proxy derived from a Rust trait.

Current limitations:

At the moment, Proxy doesn’t:

• cache properties
• track the current name owner
• prevent auto-launching

Implementations

impl<'a> Proxy<'a>

pub async fn new<E>(
    conn: &Connection,
    destination: &'a str,
    path: impl TryInto<ObjectPath<'a>, Error = E>,
    interface: &'a str
) -> Result<Proxy<'a>> where
    E: Into<Error>, 

Create a new Proxy for the given destination/path/interface.

pub async fn new_owned<E>(
    conn: Connection,
    destination: String,
    path: impl TryInto<ObjectPath<'static>, Error = E>,
    interface: String
) -> Result<Proxy<'a>> where
    E: Into<Error>, 

Create a new Proxy for the given destination/path/interface, taking ownership of all passed arguments.

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<Arc<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.

Errors

Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).

pub async fn connect_signal<H>(
    &self,
    signal_name: &'static str,
    handler: H
) -> Result<SignalHandlerId> 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. A unique ID for the handler is returned, which can be used to deregister this handler using Self::disconnect_signal method.

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 connection is not a bus connection.

pub async fn disconnect_signal(
    &self,
    handler_id: SignalHandlerId
) -> Result<bool>

Deregister the signal handler with the ID handler_id.

This method returns Ok(true) if a handler with the id handler_id is found and removed; 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 connection is not a bus connection.

pub async fn next_signal(&self) -> Result<Option<Arc<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.

Errors

This method returns the same errors as Self::receive_signal.

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 any handlers where found and called for, the signal; Ok(false) otherwise.

Trait Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a> Debug for Proxy<'a>

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

Formats the value using the given formatter.

impl<'a> From<Proxy<'a>> for Proxy<'a>

fn from(proxy: Proxy<'a>) -> Self

Performs the conversion.

impl<'a> From<Proxy<'a>> for Proxy<'a>

fn from(proxy: Proxy<'a>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for IntrospectableProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for AsyncIntrospectableProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for StatsProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for AsyncStatsProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for DBusProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for AsyncDBusProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for PropertiesProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for AsyncPropertiesProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for ObjectManagerProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for AsyncObjectManagerProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for PeerProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

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

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for MonitoringProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.

impl<'c> From<Proxy<'c>> for AsyncMonitoringProxy<'c>

fn from(proxy: Proxy<'c>) -> Self

Performs the conversion.