Struct atspi_proxies::table::TableProxyBlocking

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

Implementations

impl<'c> TableProxyBlocking<'c>

pub fn new(conn: &Connection) -> Result<TableProxyBlocking<'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 fn add_column_selection(&self, column: i32) -> Result<bool>

AddColumnSelection method

pub fn add_row_selection(&self, row: i32) -> Result<bool>

AddRowSelection method

pub fn get_accessible_at(&self, row: i32, column: i32) -> Result<Accessible>

GetAccessibleAt method

pub fn get_column_at_index(&self, index: i32) -> Result<i32>

GetColumnAtIndex method

pub fn get_column_description(&self, column: i32) -> Result<String>

GetColumnDescription method

pub fn get_column_extent_at(&self, row: i32, column: i32) -> Result<i32>

GetColumnExtentAt method

pub fn get_column_header(&self, column: i32) -> Result<Accessible>

GetColumnHeader method

pub fn get_index_at(&self, row: i32, column: i32) -> Result<i32>

GetIndexAt method

pub fn get_row_at_index(&self, index: i32) -> Result<i32>

GetRowAtIndex method

pub fn get_row_column_extents_at_index( &self, index: i32 ) -> Result<(bool, i32, i32, i32, i32, bool)>

GetRowColumnExtentsAtIndex method

pub fn get_row_description(&self, row: i32) -> Result<String>

GetRowDescription method

pub fn get_row_extent_at(&self, row: i32, column: i32) -> Result<i32>

GetRowExtentAt method

pub fn get_row_header(&self, row: i32) -> Result<Accessible>

GetRowHeader method

pub fn get_selected_columns(&self) -> Result<Vec<i32>>

GetSelectedColumns method

pub fn get_selected_rows(&self) -> Result<Vec<i32>>

GetSelectedRows method

pub fn is_column_selected(&self, column: i32) -> Result<bool>

IsColumnSelected method

pub fn is_row_selected(&self, row: i32) -> Result<bool>

IsRowSelected method

pub fn is_selected(&self, row: i32, column: i32) -> Result<bool>

IsSelected method

pub fn remove_column_selection(&self, column: i32) -> Result<bool>

RemoveColumnSelection method

pub fn remove_row_selection(&self, row: i32) -> Result<bool>

RemoveRowSelection method

pub fn caption(&self) -> Result<Accessible>

Caption property

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

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

pub fn receive_caption_changed( &self ) -> PropertyIterator<'c, <Result<Accessible> as ResultAdapter>::Ok>

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

pub fn ncolumns(&self) -> Result<i32>

NColumns property

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

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

pub fn receive_ncolumns_changed( &self ) -> PropertyIterator<'c, <Result<i32> as ResultAdapter>::Ok>

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

pub fn nrows(&self) -> Result<i32>

NRows property

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

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

pub fn receive_nrows_changed( &self ) -> PropertyIterator<'c, <Result<i32> as ResultAdapter>::Ok>

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

pub fn nselected_columns(&self) -> Result<i32>

NSelectedColumns property

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

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

pub fn receive_nselected_columns_changed( &self ) -> PropertyIterator<'c, <Result<i32> as ResultAdapter>::Ok>

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

pub fn nselected_rows(&self) -> Result<i32>

NSelectedRows property

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

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

pub fn receive_nselected_rows_changed( &self ) -> PropertyIterator<'c, <Result<i32> as ResultAdapter>::Ok>

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

pub fn summary(&self) -> Result<Accessible>

Summary property

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

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

pub fn receive_summary_changed( &self ) -> PropertyIterator<'c, <Result<Accessible> as ResultAdapter>::Ok>

Create a stream for the Summary property changes. This is a convenient wrapper around zbus::blocking::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 fn introspect(&self) -> Result<String, Error>

Introspect the associated object, and return the XML description.

See the 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 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 or call the Get method of the org.freedesktop.DBus.Properties interface.

pub 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 fn call_method<'m, M, B>( &self, method_name: M, body: &B ) -> Result<Arc<Message, Global>, 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 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 fn call_with_flags<'m, M, B, R>( &self, method_name: M, flags: BitFlags<MethodFlags, <MethodFlags as RawBitFlags>::Numeric>, 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 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 fn receive_signal<'m, M>( &self, signal_name: M ) -> Result<SignalIterator<'m>, Error>where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Create a stream for signal named signal_name.

Errors

Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).

pub fn receive_signal_with_args<'m, M>( &self, signal_name: M, args: &[(u8, &str)] ) -> Result<SignalIterator<'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 fn receive_all_signals(&self) -> Result<SignalIterator<'static>, Error>

Create a stream for all signals emitted by this service.

Errors

Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).

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

Get an iterator to receive 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.

pub fn receive_owner_changed(&self) -> Result<OwnerChangedIterator<'_>, Error>

Get an iterator 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.

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

Get a reference to the underlying async Proxy.

Trait Implementations

impl<'c> AsMut<Proxy<'c>> for TableProxyBlocking<'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 TableProxyBlocking<'c>

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

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

impl<'c> Clone for TableProxyBlocking<'c>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for TableProxyBlocking<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for TableProxyBlocking<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for TableProxyBlocking<'c>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<'a> ProxyDefault for TableProxyBlocking<'a>

const INTERFACE: &'static str = _

const DESTINATION: &'static str = _

const PATH: &'static str = _

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

fn signature() -> Signature<'static>

Get the signature for the implementing type.