Struct atspi::Connection
source · pub struct Connection { /* private fields */ }Expand description
A connection to the at-spi bus
Implementations§
source§impl Connection
impl Connection
sourcepub async fn connect(bus_addr: Address) -> Result<Self>
pub async fn connect(bus_addr: Address) -> Result<Self>
Returns a Connection, a wrapper for the RegistryProxy; a handle for the registry provider
on the accessibility bus.
You may want to call this if you have the accessibility bus address and want a connection with a convenient async event stream provisioning.
Without address, you will want to call open, which tries to obtain the accessibility bus’ address
on your behalf.
Errors
RegistryProxyis configured with invalid path, interface or destination defaults.
sourcepub fn event_stream(&self) -> impl Stream<Item = Result<Event, AtspiError>>
pub fn event_stream(&self) -> impl Stream<Item = Result<Event, AtspiError>>
Stream yielding all Event types.
Monitor this stream to be notified and receive events on the a11y bus.
Example
todo!()Methods from Deref<Target = RegistryProxy<'static>>§
sourcepub async fn deregister_event(&self, event: &str) -> Result<()>
pub async fn deregister_event(&self, event: &str) -> Result<()>
DeregisterEvent method
sourcepub async fn registered_events(&self) -> Result<Vec<(OwnedBusName, String)>>
pub async fn registered_events(&self) -> Result<Vec<(OwnedBusName, String)>>
GetRegisteredEvents method
sourcepub async fn register_event(&self, event: &str) -> Result<()>
pub async fn register_event(&self, event: &str) -> Result<()>
RegisterEvent method
sourcepub async fn receive_event_listener_deregistered(
&self
) -> Result<EventListenerDeregisteredStream<'c>>
pub async fn receive_event_listener_deregistered(
&self
) -> Result<EventListenerDeregisteredStream<'c>>
Create a stream that receives EventListenerDeregistered signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
EventListenerDeregistered signal
sourcepub async fn receive_event_listener_deregistered_with_args(
&self,
args: &[(u8, &str)]
) -> Result<EventListenerDeregisteredStream<'c>>
pub async fn receive_event_listener_deregistered_with_args(
&self,
args: &[(u8, &str)]
) -> Result<EventListenerDeregisteredStream<'c>>
Create a stream that receives EventListenerDeregistered signals.
This a convenient wrapper around zbus::Proxy::receive_signal_with_args.
EventListenerDeregistered signal
sourcepub async fn receive_event_listener_registered(
&self
) -> Result<EventListenerRegisteredStream<'c>>
pub async fn receive_event_listener_registered(
&self
) -> Result<EventListenerRegisteredStream<'c>>
Create a stream that receives EventListenerRegistered signals.
This a convenient wrapper around zbus::Proxy::receive_signal.
EventListenerRegistered signal
sourcepub async fn receive_event_listener_registered_with_args(
&self,
args: &[(u8, &str)]
) -> Result<EventListenerRegisteredStream<'c>>
pub async fn receive_event_listener_registered_with_args(
&self,
args: &[(u8, &str)]
) -> Result<EventListenerRegisteredStream<'c>>
Create a stream that receives EventListenerRegistered signals.
This a convenient wrapper around zbus::Proxy::receive_signal_with_args.
EventListenerRegistered signal
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.