Struct atspi_proxies::text::TextProxy

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

Implementations

impl<'c> TextProxy<'c>

pub async fn new(conn: &Connection) -> Result<TextProxy<'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 async fn add_selection( &self, start_offset: i32, end_offset: i32 ) -> Result<bool>

AddSelection method

pub async fn get_attribute_run( &self, offset: i32, include_defaults: bool ) -> Result<(HashMap<String, String>, i32, i32)>

GetAttributeRun method

pub async fn get_attribute_value( &self, offset: i32, attribute_name: &str ) -> Result<String>

GetAttributeValue method

pub async fn get_attributes( &self, offset: i32 ) -> Result<(HashMap<String, String>, i32, i32)>

GetAttributes method

pub async fn get_bounded_ranges( &self, x: i32, y: i32, width: i32, height: i32, coord_type: CoordType, x_clip_type: ClipType, y_clip_type: ClipType ) -> Result<Vec<(i32, i32, String, OwnedValue)>>

GetBoundedRanges method

pub async fn get_character_at_offset(&self, offset: i32) -> Result<i32>

GetCharacterAtOffset method

pub async fn get_character_extents( &self, offset: i32, coord_type: CoordType ) -> Result<(i32, i32, i32, i32)>

GetCharacterExtents method

pub async fn get_default_attribute_set(&self) -> Result<HashMap<String, String>>

GetDefaultAttributeSet method

pub async fn get_default_attributes(&self) -> Result<HashMap<String, String>>

GetDefaultAttributes method

pub async fn get_nselections(&self) -> Result<i32>

GetNSelections method

pub async fn get_offset_at_point( &self, x: i32, y: i32, coord_type: CoordType ) -> Result<i32>

GetOffsetAtPoint method

pub async fn get_range_extents( &self, start_offset: i32, end_offset: i32, coord_type: CoordType ) -> Result<(i32, i32, i32, i32)>

GetRangeExtents method

pub async fn get_selection(&self, selection_num: i32) -> Result<(i32, i32)>

GetSelection method

pub async fn get_string_at_offset( &self, offset: i32, granularity: Granularity ) -> Result<(String, i32, i32)>

GetStringAtOffset method

pub async fn get_text( &self, start_offset: i32, end_offset: i32 ) -> Result<String>

GetText method

pub async fn get_text_after_offset( &self, offset: i32, type_: u32 ) -> Result<(String, i32, i32)>

GetTextAfterOffset method

pub async fn get_text_at_offset( &self, offset: i32, type_: u32 ) -> Result<(String, i32, i32)>

GetTextAtOffset method

pub async fn get_text_before_offset( &self, offset: i32, type_: u32 ) -> Result<(String, i32, i32)>

GetTextBeforeOffset method

pub async fn remove_selection(&self, selection_num: i32) -> Result<bool>

RemoveSelection method

pub async fn scroll_substring_to( &self, start_offset: i32, end_offset: i32, type_: u32 ) -> Result<bool>

ScrollSubstringTo method

pub async fn scroll_substring_to_point( &self, start_offset: i32, end_offset: i32, type_: u32, x: i32, y: i32 ) -> Result<bool>

ScrollSubstringToPoint method

pub async fn set_caret_offset(&self, offset: i32) -> Result<bool>

SetCaretOffset method

pub async fn set_selection( &self, selection_num: i32, start_offset: i32, end_offset: i32 ) -> Result<bool>

SetSelection method

pub async fn caret_offset(&self) -> Result<i32>

CaretOffset property

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

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

pub async fn receive_caret_offset_changed( &self ) -> PropertyStream<'c, <Result<i32> as ResultAdapter>::Ok>

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

pub async fn character_count(&self) -> Result<i32>

CharacterCount property

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

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

pub async fn receive_character_count_changed( &self ) -> PropertyStream<'c, <Result<i32> as ResultAdapter>::Ok>

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

Introspect the associated object, and return the XML description.

See the xml or quick_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 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.

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.

pub async fn call_method<'m, M, B>( &self, method_name: M, body: &B ) -> impl Future<Output = 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 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.

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

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.

pub async fn receive_signal<'m, M>( &self, signal_name: M ) -> impl Future<Output = Result<SignalStream<'m>, Error>>where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Create a stream for signal named signal_name.

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

Create a stream for all signals emitted by this service.

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.

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

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

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

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

impl<'c> Clone for TextProxy<'c>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for TextProxy<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for TextProxy<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> DerefMut for TextProxy<'c>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<'a> ProxyDefault for TextProxy<'a>

const INTERFACE: &'static str = _

const DESTINATION: &'static str = _

const PATH: &'static str = _

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

fn signature() -> Signature<'static>

Get the signature for the implementing type.