Struct atspi_proxies::application::ApplicationProxy

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

Application is the interface which is implemented by each accessible application. It is implemented for the root object of an application.

It provides information about the application itself.

Status

A number of methods and properties of this interface have fallen in disuse or are / may be deprecated in the future.

• id
• set_id
• atspi_version
• get_locale

toolkit_name and version are still in use.

See the documentation of the individual methods and properties for details.

Implementations

impl<'c> ApplicationProxy<'c>

pub async fn new(conn: &Connection) -> Result<ApplicationProxy<'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 get_locale(&self, lctype: u32) -> Result<String>

Method to retrieve the application’s locale.

Deprecation

This method is likely to be removed in the future.

There is no need to call this method because there is also locale which offers the same functionality at the accessible object level.

See also: Orca issues: “Plans for per-object locale?”

member: “GetLocale”, type: method

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

retrieves AT-SPI2 version.

Applications are advised to return “2.1” here, thus that is what users should expect.

This was intended to be the version of the atspi interfaces that the application supports, but atspi will probably move to using versioned interface names instead.

member: “AtspiVersion”, type: property

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

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

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

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

pub async fn id(&self) -> Result<i32>

Retrieve numerical id of the application.

The ‘id’ is set an arbitrary numerical id when an application registers with the registry.

When a freshly-started application uses the org.a11y.atspi.Socket’s embed method to register with the accessibility registry, the registry will set a numerical id on the application.

status

The property has fallen in disuse.

As per AT-SPI2-CORE issue #82 it may turn out that this id is not actually used subsequently. This is a remnant of the time when registryd actually had to make up identifiers for each application. With DBus, however, it is the bus that assigns unique names to applications that connect to it.

Applications or toolkits can remember the Id passed when the accessibility registry sets this property, and return it back when the property is read.

member: “Id”, type: property

pub fn cached_id( &self ) -> Result<Option<<Result<i32> as ResultAdapter>::Ok>, <Result<i32> as ResultAdapter>::Err>

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

pub async fn receive_id_changed( &self ) -> PropertyStream<'c, <Result<i32> as ResultAdapter>::Ok>

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

pub async fn set_id(&self, value: i32) -> Result<()>

Set ID of the application.

This method is used by the accessibility registry to set the application’s id.

status

The property has fallen in disuse.

See id for details.

member: “Id”, type: property

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

Retrieves the name of the toolkit used to implement the application’s user interface.

member: “ToolkitName”, type: property

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

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

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

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

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

Returns the version of the toolkit used to implement the application’s user interface.

member: “Version”, type: property

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

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

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

Create a stream for the Version 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, Error>

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>, Error>

where T: TryFrom<OwnedValue>, <T as TryFrom<OwnedValue>>::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, Error>

where T: TryFrom<OwnedValue>, <T as TryFrom<OwnedValue>>::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<(), Error>

where T: '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<'m, M, B>( &self, method_name: M, body: &B ) -> Result<Arc<Message>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'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, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'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>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'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<(), Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'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>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'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>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'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>, Error>

Create a stream for all signals emitted by this service.

pub async fn receive_property_changed<'name, T>( &self, name: &'name str ) -> PropertyStream<'a, T>

where 'name: 'a,

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<'_>, Error>

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 ApplicationProxy<'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 ApplicationProxy<'c>

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

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

impl<'c> Clone for ApplicationProxy<'c>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for ApplicationProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for ApplicationProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for ApplicationProxy<'c>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<'a> ProxyDefault for ApplicationProxy<'a>

const INTERFACE: &'static str = "org.a11y.atspi.Application"

const DESTINATION: &'static str = "org.a11y.atspi.Application"

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

impl<'c> Serialize for ApplicationProxy<'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 ApplicationProxy<'c>

fn signature() -> Signature<'static>

Get the signature for the implementing type.