Struct atspi::collection::CollectionProxy
source · pub struct CollectionProxy<'c>(_);Implementations
sourceimpl<'c> CollectionProxy<'c>
impl<'c> CollectionProxy<'c>
sourcepub async fn new(conn: &Connection) -> Result<CollectionProxy<'c>>
pub async fn new(conn: &Connection) -> Result<CollectionProxy<'c>>
Creates a new proxy with the default service & 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_active_descendant(&self) -> Result<(String, OwnedObjectPath)>
pub async fn get_active_descendant(&self) -> Result<(String, OwnedObjectPath)>
GetActiveDescendant method
sourcepub async fn get_matches(
&self,
rule: &(&[i32], MatchType, HashMap<&str, &str>, MatchType, &[i32], MatchType, &[&str], MatchType, bool),
sortby: SortOrder,
count: i32,
traverse: bool
) -> Result<Vec<(String, OwnedObjectPath)>>
pub async fn get_matches(
&self,
rule: &(&[i32], MatchType, HashMap<&str, &str>, MatchType, &[i32], MatchType, &[&str], MatchType, bool),
sortby: SortOrder,
count: i32,
traverse: bool
) -> Result<Vec<(String, OwnedObjectPath)>>
GetMatches method
sourcepub async fn get_matches_from(
&self,
current_object: &ObjectPath<'_>,
rule: &(&[i32], MatchType, HashMap<&str, &str>, MatchType, &[i32], MatchType, &[&str], MatchType, bool),
sortby: SortOrder,
tree: TreeTraversalType,
count: i32,
traverse: bool
) -> Result<Vec<(String, OwnedObjectPath)>>
pub async fn get_matches_from(
&self,
current_object: &ObjectPath<'_>,
rule: &(&[i32], MatchType, HashMap<&str, &str>, MatchType, &[i32], MatchType, &[&str], MatchType, bool),
sortby: SortOrder,
tree: TreeTraversalType,
count: i32,
traverse: bool
) -> Result<Vec<(String, OwnedObjectPath)>>
GetMatchesFrom method
sourcepub async fn get_matches_to(
&self,
current_object: &ObjectPath<'_>,
rule: &(&[i32], MatchType, HashMap<&str, &str>, MatchType, &[i32], MatchType, &[&str], MatchType, bool),
sortby: SortOrder,
tree: TreeTraversalType,
limit_scope: bool,
count: i32,
traverse: bool
) -> Result<Vec<(String, OwnedObjectPath)>>
pub async fn get_matches_to(
&self,
current_object: &ObjectPath<'_>,
rule: &(&[i32], MatchType, HashMap<&str, &str>, MatchType, &[i32], MatchType, &[&str], MatchType, bool),
sortby: SortOrder,
tree: TreeTraversalType,
limit_scope: bool,
count: i32,
traverse: bool
) -> Result<Vec<(String, OwnedObjectPath)>>
GetMatchesTo method
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 async fn introspect(&self) -> impl Future<Output = Result<String, Error>>
pub async fn introspect(&self) -> impl Future<Output = Result<String, Error>>
Introspect the associated object, and return the XML description.
See the xml module for parsing the result.
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 self,
property_name: &'p str
) -> Option<impl Deref<Target = Value<'static>> + 'p>
pub fn cached_property_raw(
&'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_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_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
sourceimpl<'c> AsMut<Proxy<'c>> for CollectionProxy<'c>
impl<'c> AsMut<Proxy<'c>> for CollectionProxy<'c>
sourceimpl<'c> AsRef<Proxy<'c>> for CollectionProxy<'c>
impl<'c> AsRef<Proxy<'c>> for CollectionProxy<'c>
sourceimpl<'c> Clone for CollectionProxy<'c>
impl<'c> Clone for CollectionProxy<'c>
sourcefn clone(&self) -> CollectionProxy<'c>
fn clone(&self) -> CollectionProxy<'c>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more