Struct DBusProxy

pub struct DBusProxy<'c>(/* private fields */);

Proxy for the org.freedesktop.DBus interface.

Implementations

impl<'c> DBusProxy<'c>

pub async fn new(conn: &Connection) -> Result<DBusProxy<'c>>

Creates a new proxy with the default service and path.

pub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>

Returns a customizable builder for this proxy.

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

Consumes self, returning the underlying zbus::Proxy.

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

The reference to the underlying zbus::Proxy.

pub async fn add_match(&self, rule: &str) -> Result<()>

👎Deprecated since 3.5.0: Use add_match_rule instead

Adds a match rule to match messages going through the message bus

pub async fn add_match_rule(&self, rule: MatchRule<'_>) -> Result<()>

Adds a match rule to match messages going through the message bus

pub async fn get_adt_audit_session_data( &self, bus_name: BusName<'_>, ) -> Result<Vec<u8>>

Returns auditing data used by Solaris ADT, in an unspecified binary format.

pub async fn get_connection_credentials( &self, bus_name: BusName<'_>, ) -> Result<ConnectionCredentials>

Returns as many credentials as possible for the process connected to the server.

pub async fn get_connection_selinux_security_context( &self, bus_name: BusName<'_>, ) -> Result<Vec<u8>>

Returns the security context used by SELinux, in an unspecified format.

pub async fn get_connection_unix_process_id( &self, bus_name: BusName<'_>, ) -> Result<u32>

Returns the Unix process ID of the process connected to the server.

pub async fn get_connection_unix_user( &self, bus_name: BusName<'_>, ) -> Result<u32>

Returns the Unix user ID of the process connected to the server.

pub async fn get_id(&self) -> Result<Guid>

Gets the unique ID of the bus.

pub async fn get_name_owner(&self, name: BusName<'_>) -> Result<OwnedUniqueName>

Returns the unique connection name of the primary owner of the name given.

pub async fn hello(&self) -> Result<OwnedUniqueName>

Returns the unique name assigned to the connection.

pub async fn list_activatable_names(&self) -> Result<Vec<OwnedBusName>>

Returns a list of all names that can be activated on the bus.

pub async fn list_names(&self) -> Result<Vec<OwnedBusName>>

Returns a list of all currently-owned names on the bus.

pub async fn list_queued_owners( &self, name: WellKnownName<'_>, ) -> Result<Vec<OwnedUniqueName>>

List the connections currently queued for a bus name.

pub async fn name_has_owner(&self, name: BusName<'_>) -> Result<bool>

Checks if the specified name exists (currently has an owner).

pub async fn release_name( &self, name: WellKnownName<'_>, ) -> Result<ReleaseNameReply>

Ask the message bus to release the method caller’s claim to the given name.

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

Reload server configuration.

pub async fn remove_match(&self, rule: &str) -> Result<()>

👎Deprecated since 3.5.0: Use remove_match_rule instead

Removes the first rule that matches.

pub async fn remove_match_rule(&self, rule: MatchRule<'_>) -> Result<()>

Removes the first rule that matches.

pub async fn request_name( &self, name: WellKnownName<'_>, flags: BitFlags<RequestNameFlags>, ) -> Result<RequestNameReply>

Ask the message bus to assign the given name to the method caller.

pub async fn start_service_by_name( &self, name: WellKnownName<'_>, flags: u32, ) -> Result<u32>

Tries to launch the executable associated with a name (service activation), as an explicit request.

pub async fn update_activation_environment( &self, environment: HashMap<&str, &str>, ) -> Result<()>

This method adds to or modifies that environment when activating services.

pub async fn receive_name_owner_changed( &self, ) -> Result<NameOwnerChangedStream<'static>>

Create a stream that receives NameOwnerChanged signals.

This a convenient wrapper around zbus::Proxy::receive_signal. This signal indicates that the owner of a name has changed. It’s also the signal to use to detect the appearance of new names on the bus.

pub async fn receive_name_owner_changed_with_args( &self, args: &[(u8, &str)], ) -> Result<NameOwnerChangedStream<'static>>

Create a stream that receives NameOwnerChanged signals.

This a convenient wrapper around zbus::Proxy::receive_signal_with_args. This signal indicates that the owner of a name has changed. It’s also the signal to use to detect the appearance of new names on the bus.

pub async fn receive_name_lost(&self) -> Result<NameLostStream<'static>>

Create a stream that receives NameLost signals.

This a convenient wrapper around zbus::Proxy::receive_signal. This signal is sent to a specific application when it loses ownership of a name.

pub async fn receive_name_lost_with_args( &self, args: &[(u8, &str)], ) -> Result<NameLostStream<'static>>

Create a stream that receives NameLost signals.

This a convenient wrapper around zbus::Proxy::receive_signal_with_args. This signal is sent to a specific application when it loses ownership of a name.

pub async fn receive_name_acquired(&self) -> Result<NameAcquiredStream<'static>>

Create a stream that receives NameAcquired signals.

This a convenient wrapper around zbus::Proxy::receive_signal. This signal is sent to a specific application when it gains ownership of a name.

pub async fn receive_name_acquired_with_args( &self, args: &[(u8, &str)], ) -> Result<NameAcquiredStream<'static>>

Create a stream that receives NameAcquired signals.

This a convenient wrapper around zbus::Proxy::receive_signal_with_args. This signal is sent to a specific application when it gains ownership of a name.

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

This property lists abstract “features” provided by the message bus, and can be used by clients to detect the capabilities of the message bus with which they are communicating.

pub fn cached_features( &self, ) -> Result<Option<<Result<Vec<String>> as ResultAdapter>::Ok>, <Result<Vec<String>> as ResultAdapter>::Err>

Get the cached value of the Features property, or None if the property is not cached.

pub async fn receive_features_changed( &self, ) -> PropertyStream<'c, <Result<Vec<String>> as ResultAdapter>::Ok>

Create a stream for the Features property changes. This is a convenient wrapper around zbus::Proxy::receive_property_changed.

pub async fn interfaces(&self) -> Result<Vec<OwnedInterfaceName>>

This property lists interfaces provided by the /org/freedesktop/DBus object, and can be used by clients to detect the capabilities of the message bus with which they are communicating. Unlike the standard Introspectable interface, querying this property does not require parsing XML. This property was added in version 1.11.x of the reference implementation of the message bus.

The standard org.freedesktop.DBus and org.freedesktop.DBus.Properties interfaces are not included in the value of this property, because their presence can be inferred from the fact that a method call on org.freedesktop.DBus.Properties asking for properties of org.freedesktop.DBus was successful. The standard org.freedesktop.DBus.Peer and org.freedesktop.DBus.Introspectable interfaces are not included in the value of this property either, because they do not indicate features of the message bus implementation.

pub fn cached_interfaces( &self, ) -> Result<Option<<Result<Vec<OwnedInterfaceName>> as ResultAdapter>::Ok>, <Result<Vec<OwnedInterfaceName>> as ResultAdapter>::Err>

Get the cached value of the Interfaces property, or None if the property is not cached.

pub async fn receive_interfaces_changed( &self, ) -> PropertyStream<'c, <Result<Vec<OwnedInterfaceName>> as ResultAdapter>::Ok>

Create a stream for the Interfaces property changes. This is a convenient wrapper around zbus::Proxy::receive_property_changed.

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

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

pub fn destination(&self) -> &BusName<'_>

Get a reference to the destination service name.

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

Get a reference to the object path.

pub fn interface(&self) -> &InterfaceName<'_>

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 or quick_xml module for parsing the result.

pub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>>

where T: TryFrom<OwnedValue>, T::Error: Into<Error>,

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.

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.

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

where T: TryFrom<OwnedValue>, T::Error: Into<Error>,

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.

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

where T: Into<Value<'t>> + 't,

Set the property property_name.

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

pub async fn call_method<'m, M, B>( &self, method_name: M, body: &B, ) -> Result<Arc<Message>>

where M: TryInto<MemberName<'m>>, M::Error: Into<Error>, B: Serialize + DynamicType,

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<'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: 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 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: DeserializeOwned + Type,

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

pub async fn call_noreply<'m, M, B>( &self, method_name: M, body: &B, ) -> Result<()>

where M: TryInto<MemberName<'m>>, M::Error: Into<Error>, B: Serialize + DynamicType,

Call a method without expecting a reply

This sets the NoReplyExpected flag on the calling message and does not wait for a reply.

pub async fn receive_signal<'m, M>( &self, signal_name: M, ) -> Result<SignalStream<'m>>

where M: TryInto<MemberName<'m>>, M::Error: Into<Error>,

Create a stream for signal named signal_name.

pub async fn receive_signal_with_args<'m, M>( &self, signal_name: M, args: &[(u8, &str)], ) -> Result<SignalStream<'m>>

where M: TryInto<MemberName<'m>>, M::Error: Into<Error>,

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.

pub async fn receive_all_signals(&self) -> Result<SignalStream<'static>>

Create a stream for all signals emitted by this service.

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.

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

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

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

Converts this type into a mutable reference of the (usually inferred) input type.

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

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<'c> Clone for DBusProxy<'c>

fn clone(&self) -> DBusProxy<'c>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for DBusProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for DBusProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for DBusProxy<'c>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<'a> ProxyDefault for DBusProxy<'a>

const INTERFACE: &'static str = "org.freedesktop.DBus"

const DESTINATION: &'static str = "org.freedesktop.DBus"

const PATH: &'static str = "/org/freedesktop/DBus"

impl<'c> Serialize for DBusProxy<'c>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'c> Type for DBusProxy<'c>

fn signature() -> Signature<'static>

Get the signature for the implementing type.