Struct zbus::fdo::DBusProxy [−][src]
pub struct DBusProxy<'c>(_);Expand description
Proxy for the org.freedesktop.DBus interface.
Implementations
Creates a new proxy with the default service & path.
Returns a customizable builder for this proxy.
Consumes self, returning the underlying zbus::Proxy.
Adds a match rule to match messages going through the message bus
Returns auditing data used by Solaris ADT, in an unspecified binary format.
pub async fn get_connection_credentials(
&self,
bus_name: BusName<'_>
) -> Result<HashMap<String, OwnedValue>>
pub async fn get_connection_credentials(
&self,
bus_name: BusName<'_>
) -> Result<HashMap<String, OwnedValue>>
Returns as many credentials as possible for the process connected to the server.
Returns the security context used by SELinux, in an unspecified format.
Returns the Unix process ID of the process connected to the server.
Returns the Unix user ID of the process connected to the server.
Returns the unique connection name of the primary owner of the name given.
Returns the unique name assigned to the connection.
Returns a list of all names that can be activated on the bus.
Returns a list of all currently-owned names on the bus.
pub async fn list_queued_owners(
&self,
name: WellKnownName<'_>
) -> Result<Vec<OwnedUniqueName>>
pub async fn list_queued_owners(
&self,
name: WellKnownName<'_>
) -> Result<Vec<OwnedUniqueName>>
List the connections currently queued for a bus name.
Checks if the specified name exists (currently has an owner).
Ask the message bus to release the method caller’s claim to the given name.
Reload server configuration.
Removes the first rule that matches.
pub async fn request_name(
&self,
name: WellKnownName<'_>,
flags: BitFlags<RequestNameFlags>
) -> Result<RequestNameReply>
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.
Tries to launch the executable associated with a name (service activation), as an explicit request.
This method adds to or modifies that environment when activating services.
pub async fn connect_name_owner_changed<__H>(
&self,
handler: __H
) -> Result<SignalHandlerId> where
__H: FnMut(BusName<'_>, Optional<UniqueName<'_>>, Optional<UniqueName<'_>>) -> BoxFuture<'static, ()> + Send + 'static,
pub async fn connect_name_owner_changed<__H>(
&self,
handler: __H
) -> Result<SignalHandlerId> where
__H: FnMut(BusName<'_>, Optional<UniqueName<'_>>, Optional<UniqueName<'_>>) -> BoxFuture<'static, ()> + Send + 'static,
Connect the handler for the NameOwnerChanged signal. This is a convenient wrapper around zbus::Proxy::connect_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.
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 connect_name_lost<__H>(
&self,
handler: __H
) -> Result<SignalHandlerId> where
__H: FnMut(BusName<'_>) -> BoxFuture<'static, ()> + Send + 'static,
pub async fn connect_name_lost<__H>(
&self,
handler: __H
) -> Result<SignalHandlerId> where
__H: FnMut(BusName<'_>) -> BoxFuture<'static, ()> + Send + 'static,
Connect the handler for the NameLost signal. This is a convenient wrapper around zbus::Proxy::connect_signal.
This signal is sent to a specific application when it loses ownership of a name.
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 connect_name_acquired<__H>(
&self,
handler: __H
) -> Result<SignalHandlerId> where
__H: FnMut(BusName<'_>) -> BoxFuture<'static, ()> + Send + 'static,
pub async fn connect_name_acquired<__H>(
&self,
handler: __H
) -> Result<SignalHandlerId> where
__H: FnMut(BusName<'_>) -> BoxFuture<'static, ()> + Send + 'static,
Connect the handler for the NameAcquired signal. This is a convenient wrapper around zbus::Proxy::connect_signal.
This signal is sent to a specific application when it gains ownership of a name.
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.
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>
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 connect_features_changed<__H>(
&self,
handler: __H
) -> Result<PropertyChangedHandlerId> where
for<'v> __H: FnMut(Option<&'v Value<'_>>) -> BoxFuture<'v, ()> + Send + 'static,
pub async fn connect_features_changed<__H>(
&self,
handler: __H
) -> Result<PropertyChangedHandlerId> where
for<'v> __H: FnMut(Option<&'v Value<'_>>) -> BoxFuture<'v, ()> + Send + 'static,
Connect the handler for the Features property. This is a convenient wrapper around zbus::Proxy::connect_property_changed.
pub async fn receive_features_changed(
&self
) -> PropertyStream<'static, <Result<Vec<String>> as ResultAdapter>::Ok>
pub async fn receive_features_changed(
&self
) -> PropertyStream<'static, <Result<Vec<String>> as ResultAdapter>::Ok>
Create a stream for the Features property changes. This is a convenient wrapper around zbus::Proxy::receive_property_stream.
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>
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 connect_interfaces_changed<__H>(
&self,
handler: __H
) -> Result<PropertyChangedHandlerId> where
for<'v> __H: FnMut(Option<&'v Value<'_>>) -> BoxFuture<'v, ()> + Send + 'static,
pub async fn connect_interfaces_changed<__H>(
&self,
handler: __H
) -> Result<PropertyChangedHandlerId> where
for<'v> __H: FnMut(Option<&'v Value<'_>>) -> BoxFuture<'v, ()> + Send + 'static,
Connect the handler for the Interfaces property. This is a convenient wrapper around zbus::Proxy::connect_property_changed.
pub async fn receive_interfaces_changed(
&self
) -> PropertyStream<'static, <Result<Vec<OwnedInterfaceName>> as ResultAdapter>::Ok>
pub async fn receive_interfaces_changed(
&self
) -> PropertyStream<'static, <Result<Vec<OwnedInterfaceName>> as ResultAdapter>::Ok>
Create a stream for the Interfaces property changes. This is a convenient wrapper around zbus::Proxy::receive_property_stream.
Methods from Deref<Target = Proxy<'c>>
Register a changed handler for the property named property_name.
A unique ID for the handler is returned, which can be used to deregister this handler
using Self::disconnect_property_changed method.
Note: The signal handler will be called by the executor thread of the Connection.
See the Connection::executor documentation for an example of how you can run the
executor (and in turn all the signal handlers called) in your own thread.
Errors
The current implementation requires cached properties. It returns an Error::Unsupported
if the proxy isn’t setup with cache.
pub async fn disconnect_property_changed(
&self,
handler_id: PropertyChangedHandlerId
) -> Result<bool>
pub async fn disconnect_property_changed(
&self,
handler_id: PropertyChangedHandlerId
) -> Result<bool>
Deregister the property 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.
Get a reference to the associated connection.
Get a reference to the destination service name.
Get a reference to the object path.
Get a reference to the interface.
Introspect the associated object, and return the XML description.
See the xml module for parsing the result.
pub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>> where
T: TryFrom<OwnedValue>,
pub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>> where
T: TryFrom<OwnedValue>,
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 async fn get_property<T>(&self, property_name: &str) -> Result<T> where
T: TryFrom<OwnedValue>,
pub async fn get_property<T>(&self, property_name: &str) -> Result<T> where
T: TryFrom<OwnedValue>,
Get the property property_name.
Get the property value from the cache (if caching is enabled on this proxy) or call the
Get method of the org.freedesktop.DBus.Properties interface.
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,
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,
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 receive_signal<M>(
&self,
signal_name: M
) -> Result<SignalStream<'a>> where
M: TryInto<MemberName<'static>>,
M::Error: Into<Error>,
pub async fn receive_signal<M>(
&self,
signal_name: M
) -> Result<SignalStream<'a>> where
M: TryInto<MemberName<'static>>,
M::Error: Into<Error>,
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<M, H>(
&self,
signal_name: M,
handler: H
) -> Result<SignalHandlerId> where
M: TryInto<MemberName<'static>>,
M::Error: Into<Error>,
for<'msg> H: FnMut(&'msg Message) -> BoxFuture<'msg, ()> + Send + 'static,
pub async fn connect_signal<M, H>(
&self,
signal_name: M,
handler: H
) -> Result<SignalHandlerId> where
M: TryInto<MemberName<'static>>,
M::Error: Into<Error>,
for<'msg> H: FnMut(&'msg Message) -> BoxFuture<'msg, ()> + Send + 'static,
Register a handler for signal named signal_name.
A unique ID for the handler is returned, which can be used to deregister this handler using
Self::disconnect_signal method.
Note: The signal handler will be called by the executor thread of the Connection.
See the Connection::executor documentation for an example of how you can run the
executor (and in turn all the signal handlers called) in your own thread.
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.
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.
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.
Trait Implementations
Auto Trait Implementations
impl<'c> !RefUnwindSafe for DBusProxy<'c>
impl<'c> !UnwindSafe for DBusProxy<'c>
Blanket Implementations
Mutably borrows from an owned value. Read more
Get the signature for the implementing type. Read more