Struct CollectionProxy

pub struct CollectionProxy<'p>(/* private fields */);

Implementations

impl<'p> CollectionProxy<'p>

pub async fn new(conn: &Connection) -> Result<CollectionProxy<'p>>

Creates a new proxy with the default service and path.

pub fn builder(conn: &Connection) -> Builder<'p, Self>

Returns a customizable builder for this proxy.

pub fn into_inner(self) -> Proxy<'p>

Consumes self, returning the underlying zbus::Proxy.

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

The reference to the underlying zbus::Proxy.

pub fn inner_mut(&mut self) -> &mut Proxy<'p>

The mutable reference to the underlying zbus::Proxy.

pub async fn get_active_descendant(&self) -> Result<ObjectRef>

The active descendant of the given object.

May not be implemented by any known toolkit or private implementation.

See atspi/collection.c

pub async fn get_matches( &self, rule: ObjectMatchRule, sortby: SortOrder, count: i32, traverse: bool, ) -> Result<Vec<ObjectRef>>

Retrieves a list of objects that match the specified ObjectMatchRule, ordered according to SortOrder and limited by the count parameter.

Arguments

• rule - An ObjectMatchRule describing the match criteria.
• sortby - A SortOrder specifying the way the results are to be sorted.
• count - The maximum number of results to return, or 0 for no limit.
• traverse - Not supported.

pub async fn get_matches_from( &self, current_object: &ObjectPath<'_>, rule: ObjectMatchRule, sortby: SortOrder, tree: TreeTraversalType, count: i32, traverse: bool, ) -> Result<Vec<ObjectRef>>

Retrieves objects from the collection, after current_object, matching a given rule.

Arguments

• current_object - The object at which to start searching.
• rule - An ObjectMatchRule describing the match criteria.
• sortby - A SortOrder specifying the way the results are to be sorted.
• tree - A TreeTraversalType specifying restrictions on the objects to be traversed.
• count - The maximum number of results to return, or 0 for no limit.
• traverse - Not supported by the known implementation (atk-collection).

pub async fn get_matches_to( &self, current_object: &ObjectPath<'_>, rule: ObjectMatchRule, sortby: SortOrder, tree: TreeTraversalType, limit_scope: bool, count: i32, traverse: bool, ) -> Result<Vec<ObjectRef>>

Retrieves objects from the collection, before current_object, matching a given rule.

Arguments

• current_object - The object at which to start searching.
• rule - An ObjectMatchRule describing the match criteria.
• sortby - A SortOrder specifying the way the results are to be sorted.
• tree - A TreeTraversalType specifying restrictions on the objects to be traversed.
• limit_scope - If true, only descendants of current_object’s parent will be returned. Otherwise (if false), any accessible may be returned if it would preceed current_object in a flattened hierarchy.
• count - The maximum number of results to return, or 0 for no limit.
• traverse - Not supported by the known implementation (atk-collection).

Trait Implementations

impl<'p> AsMut<Proxy<'p>> for CollectionProxy<'p>

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

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

impl<'p> AsRef<Proxy<'p>> for CollectionProxy<'p>

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

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

impl<'p> Clone for CollectionProxy<'p>

fn clone(&self) -> CollectionProxy<'p>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'p> Debug for CollectionProxy<'p>

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

Formats the value using the given formatter.

impl<'a> Defaults for CollectionProxy<'a>

const INTERFACE: &'static Option<InterfaceName<'static>>

const DESTINATION: &'static Option<BusName<'static>>

const PATH: &'static Option<ObjectPath<'static>>

impl<'p> From<Proxy<'p>> for CollectionProxy<'p>

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

Converts to this type from the input type.

impl<'p> ProxyImpl<'p> for CollectionProxy<'p>

fn builder(conn: &Connection) -> Builder<'p, Self>

Return a customizable builder for this proxy.

fn into_inner(self) -> Proxy<'p>

Consume self, returning the underlying zbus::Proxy.

fn inner(&self) -> &Proxy<'p>

The reference to the underlying zbus::Proxy.

impl<'p> Serialize for CollectionProxy<'p>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'p> Type for CollectionProxy<'p>

const SIGNATURE: &'static Signature

The signature for the implementing type, in parsed format.