Struct atspi::accessible::AccessibleProxy
source · pub struct AccessibleProxy<'c>(_);Implementations§
source§impl<'c> AccessibleProxy<'c>
impl<'c> AccessibleProxy<'c>
sourcepub async fn new(conn: &Connection) -> Result<AccessibleProxy<'c>>
pub async fn new(conn: &Connection) -> Result<AccessibleProxy<'c>>
Creates a new proxy with the default service and path.
sourcepub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>
pub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>
Returns a customizable builder for this proxy.
sourcepub fn into_inner(self) -> Proxy<'c>
pub fn into_inner(self) -> Proxy<'c>
Consumes self, returning the underlying zbus::Proxy.
sourcepub async fn get_application(&self) -> Result<(String, OwnedObjectPath)>
pub async fn get_application(&self) -> Result<(String, OwnedObjectPath)>
GetApplication method
sourcepub async fn get_child_at_index(
&self,
index: i32
) -> Result<(String, OwnedObjectPath)>
pub async fn get_child_at_index(
&self,
index: i32
) -> Result<(String, OwnedObjectPath)>
GetChildAtIndex method
sourcepub async fn get_children(&self) -> Result<Vec<(String, OwnedObjectPath)>>
pub async fn get_children(&self) -> Result<Vec<(String, OwnedObjectPath)>>
GetChildren method
sourcepub async fn get_index_in_parent(&self) -> Result<i32>
pub async fn get_index_in_parent(&self) -> Result<i32>
GetIndexInParent method; this will give an index between 0 and n, where n is the number of children in the parent.
sourcepub async fn get_interfaces(&self) -> Result<InterfaceSet>
pub async fn get_interfaces(&self) -> Result<InterfaceSet>
GetInterfaces method
sourcepub async fn get_localized_role_name(&self) -> Result<String>
pub async fn get_localized_role_name(&self) -> Result<String>
GetLocalizedRoleName method
sourcepub async fn get_relation_set(&self) -> Result<RelationSet>
pub async fn get_relation_set(&self) -> Result<RelationSet>
GetRelationSet method
sourcepub async fn get_role_name(&self) -> Result<String>
pub async fn get_role_name(&self) -> Result<String>
GetRoleName method
sourcepub async fn accessible_id(&self) -> Result<String>
pub async fn accessible_id(&self) -> Result<String>
AccessibleId property
sourcepub fn cached_accessible_id(
&self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
pub fn cached_accessible_id(
&self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
Get the cached value of the AccessibleId property, or None if the property is not cached.
sourcepub async fn receive_accessible_id_changed(
&self
) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>
pub async fn receive_accessible_id_changed(
&self
) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>
Create a stream for the AccessibleId property changes. This is a convenient wrapper around zbus::Proxy::receive_property_changed.
sourcepub async fn child_count(&self) -> Result<i32>
pub async fn child_count(&self) -> Result<i32>
ChildCount property
sourcepub fn cached_child_count(
&self
) -> Result<Option<<Result<i32> as ResultAdapter>::Ok>, <Result<i32> as ResultAdapter>::Err>
pub fn cached_child_count(
&self
) -> Result<Option<<Result<i32> as ResultAdapter>::Ok>, <Result<i32> as ResultAdapter>::Err>
Get the cached value of the ChildCount property, or None if the property is not cached.
sourcepub async fn receive_child_count_changed(
&self
) -> PropertyStream<'c, <Result<i32> as ResultAdapter>::Ok>
pub async fn receive_child_count_changed(
&self
) -> PropertyStream<'c, <Result<i32> as ResultAdapter>::Ok>
Create a stream for the ChildCount property changes. This is a convenient wrapper around zbus::Proxy::receive_property_changed.
sourcepub async fn description(&self) -> Result<String>
pub async fn description(&self) -> Result<String>
Description property
sourcepub fn cached_description(
&self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
pub fn cached_description(
&self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
Get the cached value of the Description property, or None if the property is not cached.
sourcepub async fn receive_description_changed(
&self
) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>
pub async fn receive_description_changed(
&self
) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>
Create a stream for the Description property changes. This is a convenient wrapper around zbus::Proxy::receive_property_changed.
sourcepub fn cached_locale(
&self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
pub fn cached_locale(
&self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
Get the cached value of the Locale property, or None if the property is not cached.
sourcepub async fn receive_locale_changed(
&self
) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>
pub async fn receive_locale_changed(
&self
) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>
Create a stream for the Locale property changes. This is a convenient wrapper around zbus::Proxy::receive_property_changed.
sourcepub fn cached_name(
&self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
pub fn cached_name(
&self
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
Get the cached value of the Name property, or None if the property is not cached.
sourcepub async fn receive_name_changed(
&self
) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>
pub async fn receive_name_changed(
&self
) -> PropertyStream<'c, <Result<String> as ResultAdapter>::Ok>
Create a stream for the Name property changes. This is a convenient wrapper around zbus::Proxy::receive_property_changed.
sourcepub fn cached_parent(
&self
) -> Result<Option<<Result<(String, OwnedObjectPath)> as ResultAdapter>::Ok>, <Result<(String, OwnedObjectPath)> as ResultAdapter>::Err>
pub fn cached_parent(
&self
) -> Result<Option<<Result<(String, OwnedObjectPath)> as ResultAdapter>::Ok>, <Result<(String, OwnedObjectPath)> as ResultAdapter>::Err>
Get the cached value of the Parent property, or None if the property is not cached.
sourcepub async fn receive_parent_changed(
&self
) -> PropertyStream<'c, <Result<(String, OwnedObjectPath)> as ResultAdapter>::Ok>
pub async fn receive_parent_changed(
&self
) -> PropertyStream<'c, <Result<(String, OwnedObjectPath)> as ResultAdapter>::Ok>
Create a stream for the Parent property changes. This is a convenient wrapper around zbus::Proxy::receive_property_changed.
Methods from Deref<Target = Proxy<'c>>§
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 interface(&self) -> &InterfaceName<'_>
pub fn interface(&self) -> &InterfaceName<'_>
Get a reference to the interface.
sourcepub fn cached_property<T>(&self, property_name: &str) -> Result<Option<T>, Error>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
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.
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
) -> impl Future<Output = Result<T, Error>>where
T: TryFrom<OwnedValue>,
<T as TryFrom<OwnedValue>>::Error: Into<Error>,
pub async fn get_property<T>(
&self,
property_name: &str
) -> impl Future<Output = 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.
sourcepub async fn set_property<'t, T>(
&self,
property_name: &str,
value: T
) -> impl Future<Output = Result<(), Error>>where
T: 't + Into<Value<'t>>,
pub async fn set_property<'t, T>(
&self,
property_name: &str,
value: T
) -> impl Future<Output = 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.
sourcepub async fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = Result<Arc<Message>, Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub async fn call_method<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = 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).
sourcepub async fn call<'m, M, B, R>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = Result<R, Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
R: DeserializeOwned + Type,
pub async fn call<'m, M, B, R>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = 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.
sourcepub async fn call_with_flags<'m, M, B, R>(
&self,
method_name: M,
flags: BitFlags<MethodFlags, <MethodFlags as RawBitFlags>::Numeric>,
body: &B
) -> impl Future<Output = Result<Option<R>, Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
R: DeserializeOwned + Type,
pub async fn call_with_flags<'m, M, B, R>(
&self,
method_name: M,
flags: BitFlags<MethodFlags, <MethodFlags as RawBitFlags>::Numeric>,
body: &B
) -> impl Future<Output = 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
sourcepub async fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = Result<(), Error>>where
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
B: Serialize + DynamicType,
pub async fn call_noreply<'m, M, B>(
&self,
method_name: M,
body: &B
) -> impl Future<Output = 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.
sourcepub async fn receive_signal<'m, M>(
&self,
signal_name: M
) -> impl Future<Output = Result<SignalStream<'a>, Error>>where
'm: 'a,
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
pub async fn receive_signal<'m, M>(
&self,
signal_name: M
) -> impl Future<Output = Result<SignalStream<'a>, Error>>where
'm: 'a,
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
Create a stream for signal named signal_name.
sourcepub async fn receive_signal_with_args<'m, M>(
&self,
signal_name: M,
args: &[(u8, &str)]
) -> impl Future<Output = Result<SignalStream<'a>, Error>>where
'm: 'a,
M: TryInto<MemberName<'m>>,
<M as TryInto<MemberName<'m>>>::Error: Into<Error>,
pub async fn receive_signal_with_args<'m, M>(
&self,
signal_name: M,
args: &[(u8, &str)]
) -> impl Future<Output = Result<SignalStream<'a>, Error>>where
'm: 'a,
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.
sourcepub async fn receive_all_signals(
&self
) -> impl Future<Output = Result<SignalStream<'a>, Error>>
pub async fn receive_all_signals(
&self
) -> impl Future<Output = Result<SignalStream<'a>, Error>>
Create a stream for all signals emitted by this service.
sourcepub async fn receive_property_changed<'name, T>(
&self,
name: &'name str
) -> impl Future<Output = PropertyStream<'a, T>>where
'name: 'a,
pub async fn receive_property_changed<'name, T>(
&self,
name: &'name str
) -> impl Future<Output = 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.
sourcepub async fn receive_owner_changed(
&self
) -> impl Future<Output = Result<OwnerChangedStream<'_>, Error>>
pub async fn receive_owner_changed(
&self
) -> impl Future<Output = 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§
source§impl<'impl0> AccessibleExt for AccessibleProxy<'impl0>
impl<'impl0> AccessibleExt for AccessibleProxy<'impl0>
source§fn get_id(&self) -> Option<AccessibleId>
fn get_id(&self) -> Option<AccessibleId>
get_id gets the id (if available) for any accessible.
This should always return a Some(i32) and never None, but you never know.
Sometimes, a path (/org/a11y/atspi/accessible/XYZ) may contain a special value for XYZ.
For example: “null” (invalid item), or “root” (the ancestor of all accessibles).
It should be safe to .expect() the return type.
fn get_parent_ext<'a, 'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<AccessibleProxy<'a>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn get_children_indexes<'a, 'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<i32>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn get_children_ext<'a, 'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<AccessibleProxy<'a>>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn get_siblings<'a, 'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<AccessibleProxy<'a>>, Box<dyn Error>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn get_siblings_before<'a, 'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<AccessibleProxy<'a>>, Box<dyn Error>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn get_siblings_after<'a, 'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<AccessibleProxy<'a>>, Box<dyn Error>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn get_ancestors<'a, 'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<AccessibleProxy<'a>>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn get_ancestor_with_role<'a, 'life0, 'async_trait>(
&'life0 self,
role: Role
) -> Pin<Box<dyn Future<Output = Result<AccessibleProxy<'a>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn get_children_caret<'a, 'life0, 'async_trait>(
&'life0 self,
backward: bool
) -> Pin<Box<dyn Future<Output = Result<Vec<AccessibleProxy<'a>>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn get_next<'a, 'life0, 'life1, 'async_trait>(
&'life0 self,
matcher_args: &'life1 MatcherArgs,
backward: bool
) -> Pin<Box<dyn Future<Output = Result<Option<AccessibleProxy<'a>>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn get_relation_set_ext<'a, 'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<HashMap<RelationType, Vec<AccessibleProxy<'a>>>>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
source§impl<'c> AsMut<Proxy<'c>> for AccessibleProxy<'c>
impl<'c> AsMut<Proxy<'c>> for AccessibleProxy<'c>
source§impl<'c> AsRef<Proxy<'c>> for AccessibleProxy<'c>
impl<'c> AsRef<Proxy<'c>> for AccessibleProxy<'c>
source§impl<'a> AtspiProxy for AccessibleProxy<'a>
impl<'a> AtspiProxy for AccessibleProxy<'a>
source§impl<'c> Clone for AccessibleProxy<'c>
impl<'c> Clone for AccessibleProxy<'c>
source§fn clone(&self) -> AccessibleProxy<'c>
fn clone(&self) -> AccessibleProxy<'c>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more