Struct zbus::fdo::DBusProxy

pub struct DBusProxy<'c>(_);

Proxy for the org.freedesktop.DBus interface.

Implementations

impl<'c> DBusProxy<'c>

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

Creates a new proxy with the default service & 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 fn add_match(&self, rule: &str) -> Result<()>

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

pub fn get_adt_audit_session_data(&self, bus_name: &str) -> Result<Vec<u8>>

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

pub fn get_connection_credentials(
    &self,
    bus_name: &str
) -> Result<HashMap<String, OwnedValue>>

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

pub fn get_connection_selinux_security_context(
    &self,
    bus_name: &str
) -> Result<Vec<u8>>

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

pub fn get_connection_unix_process_id(&self, bus_name: &str) -> Result<u32>

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

pub fn get_connection_unix_user(&self, bus_name: &str) -> Result<u32>

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

pub fn get_id(&self) -> Result<String>

Gets the unique ID of the bus.

pub fn get_name_owner(&self, name: &str) -> Result<String>

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

pub fn hello(&self) -> Result<String>

Returns the unique name assigned to the connection.

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

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

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

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

pub fn list_queued_owners(&self, name: &str) -> Result<Vec<String>>

List the connections currently queued for a bus name.

pub fn name_has_owner(&self, name: &str) -> Result<bool>

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

pub fn release_name(&self, name: &str) -> Result<ReleaseNameReply>

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

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

Reload server configuration.

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

Removes the first rule that matches.

pub fn request_name(
    &self,
    name: &str,
    flags: BitFlags<RequestNameFlags>
) -> Result<RequestNameReply>

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

pub fn start_service_by_name(&self, name: &str, flags: u32) -> Result<u32>

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

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

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

pub fn connect_name_owner_changed<__H>(
    &self,
    handler: __H
) -> Result<SignalHandlerId> where
    __H: FnMut(&str, &str, &str) -> Result<()> + 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.

pub fn connect_name_lost<__H>(&self, handler: __H) -> Result<SignalHandlerId> where
    __H: FnMut(&str) -> Result<()> + 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.

pub fn connect_name_acquired<__H>(
    &self,
    handler: __H
) -> Result<SignalHandlerId> where
    __H: FnMut(&str) -> Result<()> + 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.

pub 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 interfaces(&self) -> Result<Vec<String>>

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.

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 fn introspect(&self) -> Result<String>

Introspect the associated object, and return the XML description.

See the xml module for parsing the result.

pub 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 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 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 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 fn connect_signal<H>(
    &self,
    signal_name: &'static str,
    handler: H
) -> Result<SignalHandlerId> where
    H: FnMut(&Message) -> 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 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 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. Signal handlers can be registered and deregistered from another threads during the call to this method.

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

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

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

Get a reference to the underlying async Proxy.

Trait Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

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

Performs the conversion.

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

const INTERFACE: &'static str

const DESTINATION: &'static str

const PATH: &'static str

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.