pub struct Proxy<'a> { /* private fields */ }
Expand description
A client-side interface proxy.
A Proxy
is a helper to interact with an interface on a remote object.
§Example
use std::result::Result;
use std::error::Error;
use zbus::{Connection, Proxy};
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
let connection = Connection::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 body = p.call_method("GetId", &()).await?.body();
let _id: &str = body.deserialize()?;
Ok(())
}
§Note
It is recommended to use the proxy
macro, which provides a more convenient and
type-safe façade Proxy
derived from a Rust trait.
Implementations§
source§impl<'a> Proxy<'a>
impl<'a> Proxy<'a>
sourcepub async fn new<D, P, I>(
conn: &Connection,
destination: D,
path: P,
interface: I,
) -> Result<Proxy<'a>>
pub async fn new<D, P, I>( conn: &Connection, destination: D, path: P, interface: I, ) -> Result<Proxy<'a>>
Create a new Proxy
for the given destination/path/interface.
sourcepub async fn new_owned<D, P, I>(
conn: Connection,
destination: D,
path: P,
interface: I,
) -> Result<Proxy<'a>>
pub async fn new_owned<D, P, I>( conn: Connection, destination: D, path: P, interface: I, ) -> Result<Proxy<'a>>
Create a new Proxy
for the given destination/path/interface, taking ownership of all
passed arguments.
sourcepub fn connection(&self) -> &Connection
pub fn connection(&self) -> &Connection
Get a reference to the associated connection.
sourcepub fn destination(&self) -> &BusName<'_>
pub fn destination(&self) -> &BusName<'_>
Get a reference to the destination service name.
sourcepub fn path(&self) -> &ObjectPath<'_>
pub fn path(&self) -> &ObjectPath<'_>
Get a reference to the object path.
sourcepub fn interface(&self) -> &InterfaceName<'_>
pub fn interface(&self) -> &InterfaceName<'_>
Get a reference to the interface.
sourcepub async fn introspect(&self) -> Result<String>
pub async fn introspect(&self) -> Result<String>
Introspect the associated object, and return the XML description.
See the xml module for parsing the result.
sourcepub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>>
pub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>>
Get the cached value of the property property_name
.
This returns None
if the property is not in the cache. This could be because the cache
was invalidated by an update, because caching was disabled for this property or proxy, or
because the cache has not yet been populated. Use get_property
to fetch the value from
the peer.
sourcepub fn cached_property_raw<'p>(
&'p self,
property_name: &'p str,
) -> Option<impl Deref<Target = Value<'static>> + 'p>
pub fn cached_property_raw<'p>( &'p self, property_name: &'p str, ) -> Option<impl Deref<Target = Value<'static>> + 'p>
Get the cached value of the property property_name
.
Same as cached_property
, but gives you access to the raw value stored in the cache. This
is useful if you want to avoid allocations and cloning.
sourcepub async fn get_property<T>(&self, property_name: &str) -> Result<T>
pub async fn get_property<T>(&self, property_name: &str) -> Result<T>
Get the property property_name
.
Get the property value from the cache (if caching is enabled) or call the
Get
method of the org.freedesktop.DBus.Properties
interface.
sourcepub async fn set_property<'t, T>(
&self,
property_name: &str,
value: T,
) -> Result<()>
pub async fn set_property<'t, T>( &self, property_name: &str, value: T, ) -> Result<()>
Set the property property_name
.
Effectively, call the Set
method of the org.freedesktop.DBus.Properties
interface.
sourcepub async fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B,
) -> Result<Message>
pub async fn call_method<'m, M, B>( &self, method_name: M, body: &B, ) -> Result<Message>
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).
sourcepub async fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R>where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: Serialize + DynamicType,
R: for<'d> DynamicDeserialize<'d>,
pub async fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R>where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: Serialize + DynamicType,
R: for<'d> DynamicDeserialize<'d>,
Call a method and return the reply body.
Use call_method
instead if you need to deserialize the reply manually/separately.
sourcepub async fn call_with_flags<'m, M, B, R>(
&self,
method_name: M,
flags: BitFlags<MethodFlags>,
body: &B,
) -> Result<Option<R>>where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: Serialize + DynamicType,
R: for<'d> DynamicDeserialize<'d>,
pub async fn call_with_flags<'m, M, B, R>(
&self,
method_name: M,
flags: BitFlags<MethodFlags>,
body: &B,
) -> Result<Option<R>>where
M: TryInto<MemberName<'m>>,
M::Error: Into<Error>,
B: Serialize + DynamicType,
R: for<'d> DynamicDeserialize<'d>,
Call a method and return the reply body, optionally supplying a set of method flags to control the way the method call message is sent and handled.
Use call
instead if you do not need any special handling via additional flags.
If the NoReplyExpected
flag is passed , this will return None immediately
after sending the message, similar to call_noreply
sourcepub async fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B,
) -> Result<()>
pub async fn call_noreply<'m, M, B>( &self, method_name: M, body: &B, ) -> Result<()>
Call a method without expecting a reply
This sets the NoReplyExpected
flag on the calling message and does not wait for a reply.
sourcepub async fn receive_signal<'m, M>(
&self,
signal_name: M,
) -> Result<SignalStream<'m>>
pub async fn receive_signal<'m, M>( &self, signal_name: M, ) -> Result<SignalStream<'m>>
Create a stream for signal named signal_name
.
sourcepub async fn receive_signal_with_args<'m, M>(
&self,
signal_name: M,
args: &[(u8, &str)],
) -> Result<SignalStream<'m>>
pub async fn receive_signal_with_args<'m, M>( &self, signal_name: M, args: &[(u8, &str)], ) -> Result<SignalStream<'m>>
Same as Proxy::receive_signal
but with a filter.
The D-Bus specification allows you to filter signals by their arguments, which helps avoid a lot of unnecessary traffic and processing since the filter is run on the server side. Use this method where possible. Note that this filtering is limited to arguments of string types.
The arguments are passed as a tuples of argument index and expected value.
sourcepub async fn receive_all_signals(&self) -> Result<SignalStream<'static>>
pub async fn receive_all_signals(&self) -> Result<SignalStream<'static>>
Create a stream for all signals emitted by this service.
sourcepub async fn receive_property_changed<'name: 'a, T>(
&self,
name: &'name str,
) -> PropertyStream<'a, T>
pub async fn receive_property_changed<'name: 'a, T>( &self, name: &'name str, ) -> PropertyStream<'a, T>
Get a stream to receive property changed events.
Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.
If caching is not enabled on this proxy, the resulting stream will not return any events.
sourcepub async fn receive_owner_changed(&self) -> Result<OwnerChangedStream<'_>>
pub async fn receive_owner_changed(&self) -> Result<OwnerChangedStream<'_>>
Get a stream to receive destination owner changed events.
If the proxy destination is a unique name, the stream will be notified of the peer
disconnection from the bus (with a None
value).
If the proxy destination is a well-known name, the stream will be notified whenever the name
owner is changed, either by a new peer being granted ownership (Some
value) or when the
name is released (with a None
value).
Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.
Trait Implementations§
source§impl<'p> AsMut<Proxy<'p>> for IntrospectableProxy<'p>
impl<'p> AsMut<Proxy<'p>> for IntrospectableProxy<'p>
source§impl<'p> AsMut<Proxy<'p>> for MonitoringProxy<'p>
impl<'p> AsMut<Proxy<'p>> for MonitoringProxy<'p>
source§impl<'p> AsMut<Proxy<'p>> for ObjectManagerProxy<'p>
impl<'p> AsMut<Proxy<'p>> for ObjectManagerProxy<'p>
source§impl<'p> AsMut<Proxy<'p>> for PropertiesProxy<'p>
impl<'p> AsMut<Proxy<'p>> for PropertiesProxy<'p>
source§impl<'p> AsMut<Proxy<'p>> for StatsProxy<'p>
impl<'p> AsMut<Proxy<'p>> for StatsProxy<'p>
source§impl<'p> AsRef<Proxy<'p>> for IntrospectableProxy<'p>
impl<'p> AsRef<Proxy<'p>> for IntrospectableProxy<'p>
source§impl<'p> AsRef<Proxy<'p>> for MonitoringProxy<'p>
impl<'p> AsRef<Proxy<'p>> for MonitoringProxy<'p>
source§impl<'p> AsRef<Proxy<'p>> for ObjectManagerProxy<'p>
impl<'p> AsRef<Proxy<'p>> for ObjectManagerProxy<'p>
source§impl<'p> AsRef<Proxy<'p>> for PropertiesProxy<'p>
impl<'p> AsRef<Proxy<'p>> for PropertiesProxy<'p>
source§impl<'p> AsRef<Proxy<'p>> for StatsProxy<'p>
impl<'p> AsRef<Proxy<'p>> for StatsProxy<'p>
source§impl<'p> From<Proxy<'p>> for IntrospectableProxy<'p>
impl<'p> From<Proxy<'p>> for IntrospectableProxy<'p>
source§impl<'p> From<Proxy<'p>> for IntrospectableProxy<'p>
impl<'p> From<Proxy<'p>> for IntrospectableProxy<'p>
source§impl<'p> From<Proxy<'p>> for MonitoringProxy<'p>
impl<'p> From<Proxy<'p>> for MonitoringProxy<'p>
source§impl<'p> From<Proxy<'p>> for MonitoringProxy<'p>
impl<'p> From<Proxy<'p>> for MonitoringProxy<'p>
source§impl<'p> From<Proxy<'p>> for ObjectManagerProxy<'p>
impl<'p> From<Proxy<'p>> for ObjectManagerProxy<'p>
source§impl<'p> From<Proxy<'p>> for ObjectManagerProxy<'p>
impl<'p> From<Proxy<'p>> for ObjectManagerProxy<'p>
source§impl<'p> From<Proxy<'p>> for PropertiesProxy<'p>
impl<'p> From<Proxy<'p>> for PropertiesProxy<'p>
source§impl<'p> From<Proxy<'p>> for PropertiesProxy<'p>
impl<'p> From<Proxy<'p>> for PropertiesProxy<'p>
source§impl<'p> From<Proxy<'p>> for StatsProxy<'p>
impl<'p> From<Proxy<'p>> for StatsProxy<'p>
source§impl<'p> From<Proxy<'p>> for StatsProxy<'p>
impl<'p> From<Proxy<'p>> for StatsProxy<'p>
Auto Trait Implementations§
impl<'a> Freeze for Proxy<'a>
impl<'a> !RefUnwindSafe for Proxy<'a>
impl<'a> Send for Proxy<'a>
impl<'a> Sync for Proxy<'a>
impl<'a> Unpin for Proxy<'a>
impl<'a> !UnwindSafe for Proxy<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)