Struct CacheItem 

pub struct CacheItem {
    pub object: AccessiblePrimitive,
    pub app: AccessiblePrimitive,
    pub parent: CacheRef,
    pub index: i32,
    pub children_num: i32,
    pub interfaces: InterfaceSet,
    pub role: Role,
    pub states: StateSet,
    pub text: String,
    pub children: Vec<CacheRef>,
    pub cache: Weak<Cache>,
}

A struct representing an accessible. To get any information from the cache other than the stored information like role, interfaces, and states, you will need to instantiate an atspi::accessible::AccessibleProxy or other *Proxy type from atspi to query further info.

Fields

object: AccessiblePrimitive

app: AccessiblePrimitive

parent: CacheRef

index: i32

children_num: i32

interfaces: InterfaceSet

role: Role

states: StateSet

text: String

children: Vec<CacheRef>

cache: Weak<Cache>

Implementations

impl CacheItem

pub fn parent_ref(&mut self) -> OdiliaResult<Arc<RwLock<CacheItem>>>

Return a reference to a parent. This is much cheaper than getting the parent element outright via Self::parent.

Errors

This method will return a CacheError::NoItem if no item is found within the cache.

pub async fn from_atspi_event<T: Signified>( event: &T, cache: Weak<Cache>, connection: &Connection, ) -> OdiliaResult<Self>

Creates a CacheItem from an atspi::Event type.

Errors

This can fail under three possible conditions:

1. We are unable to convert information from the event into an AccessiblePrimitive hashmap key. This should never happen.
2. We are unable to convert the AccessiblePrimitive to an atspi::accessible::AccessibleProxy.
3. The accessible_to_cache_item function fails for any reason. This also shouldn’t happen.

pub async fn from_atspi_cache_item( atspi_cache_item: CacheItem, cache: Weak<Cache>, connection: &Connection, ) -> OdiliaResult<Self>

Convert an atspi::cache::CacheItem into a crate::CacheItem. This requires calls to DBus, which is quite expensive. Beware calling this too often.

Errors

This function can fail under the following conditions:

1. The atspi::cache::CacheItem can not be turned into a crate::AccessiblePrimitive. This should never happen.
2. The crate::AccessiblePrimitive can not be turned into a atspi::accessible::AccessibleProxy. This should never happen.
3. Getting children from the AccessibleProxy fails. This should never happen.

The only time these can fail is if the item is removed on the application side before the conversion to AccessibleProxy.

pub fn get_children(&self) -> OdiliaResult<Vec<Self>>

Get a Vec of children with the same type as Self.

Errors

1. Will return an Err variant if self.cache does not reference an active cache. This should never happen, but it is technically possible.
2. Any children keys’ values are not found in the cache itself.

Trait Implementations

impl Accessible for CacheItem

type Error = OdiliaError

fn get_application<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetApplication method

fn parent<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Parent property

fn get_children<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Self>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetChildren method

fn child_count<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<i32, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

ChildCount property

fn get_index_in_parent<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<i32, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetIndexInParent method; this will give an index between 0 and n, where n is the number of children in the parent.

fn get_role<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Role, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetRole method

fn get_interfaces<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<InterfaceSet, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetInterfaces method

fn get_attributes<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, String>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetAttributes method

fn name<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Name property

fn locale<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Locale property

fn description<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Description property

fn get_relation_set<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<(RelationType, Vec<Self>)>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetRelationSet method

fn get_role_name<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetRoleName method

fn get_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<StateSet, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetState method

fn get_child_at_index<'life0, 'async_trait>( &'life0 self, idx: i32, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetChildAtIndex method

fn get_localized_role_name<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetLocalizedRoleName method

fn accessible_id<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<AccessibleId, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

AccessibleId property

impl Clone for CacheItem

fn clone(&self) -> CacheItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CacheItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CacheItem

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Text for CacheItem

type Error = OdiliaError

fn add_selection<'life0, 'async_trait>( &'life0 self, start_offset: i32, end_offset: i32, ) -> Pin<Box<dyn Future<Output = Result<bool, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

AddSelection method

fn get_attribute_run<'life0, 'async_trait>( &'life0 self, offset: i32, include_defaults: bool, ) -> Pin<Box<dyn Future<Output = Result<(HashMap<String, String>, i32, i32), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetAttributeRun method

fn get_attribute_value<'life0, 'life1, 'async_trait>( &'life0 self, offset: i32, attribute_name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

GetAttributeValue method

fn get_attributes<'life0, 'async_trait>( &'life0 self, offset: i32, ) -> Pin<Box<dyn Future<Output = Result<(HashMap<String, String>, i32, i32), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetAttributes method

fn get_bounded_ranges<'life0, 'async_trait>( &'life0 self, x: i32, y: i32, width: i32, height: i32, coord_type: CoordType, x_clip_type: ClipType, y_clip_type: ClipType, ) -> Pin<Box<dyn Future<Output = Result<Vec<(i32, i32, String, OwnedValue)>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetBoundedRanges method

fn get_character_at_offset<'life0, 'async_trait>( &'life0 self, offset: i32, ) -> Pin<Box<dyn Future<Output = Result<i32, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetCharacterAtOffset method

fn get_character_extents<'life0, 'async_trait>( &'life0 self, offset: i32, coord_type: CoordType, ) -> Pin<Box<dyn Future<Output = Result<(i32, i32, i32, i32), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetCharacterExtents method

fn get_default_attribute_set<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, String>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetDefaultAttributeSet method

fn get_default_attributes<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, String>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetDefaultAttributes method

fn get_nselections<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<i32, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetNSelections method

fn get_offset_at_point<'life0, 'async_trait>( &'life0 self, x: i32, y: i32, coord_type: CoordType, ) -> Pin<Box<dyn Future<Output = Result<i32, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetOffsetAtPoint method

fn get_range_extents<'life0, 'async_trait>( &'life0 self, start_offset: i32, end_offset: i32, coord_type: CoordType, ) -> Pin<Box<dyn Future<Output = Result<(i32, i32, i32, i32), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetRangeExtents method

fn get_selection<'life0, 'async_trait>( &'life0 self, selection_num: i32, ) -> Pin<Box<dyn Future<Output = Result<(i32, i32), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetSelection method

fn get_string_at_offset<'life0, 'async_trait>( &'life0 self, offset: i32, granularity: Granularity, ) -> Pin<Box<dyn Future<Output = Result<(String, i32, i32), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetStringAtOffset method

fn get_text<'life0, 'async_trait>( &'life0 self, start_offset: i32, end_offset: i32, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetText method

fn get_text_after_offset<'life0, 'async_trait>( &'life0 self, offset: i32, type_: u32, ) -> Pin<Box<dyn Future<Output = Result<(String, i32, i32), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetTextAfterOffset method

fn get_text_at_offset<'life0, 'async_trait>( &'life0 self, offset: i32, type_: u32, ) -> Pin<Box<dyn Future<Output = Result<(String, i32, i32), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetTextAtOffset method

fn get_text_before_offset<'life0, 'async_trait>( &'life0 self, offset: i32, type_: u32, ) -> Pin<Box<dyn Future<Output = Result<(String, i32, i32), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetTextBeforeOffset method

fn remove_selection<'life0, 'async_trait>( &'life0 self, selection_num: i32, ) -> Pin<Box<dyn Future<Output = Result<bool, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

RemoveSelection method

fn scroll_substring_to<'life0, 'async_trait>( &'life0 self, start_offset: i32, end_offset: i32, type_: u32, ) -> Pin<Box<dyn Future<Output = Result<bool, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

ScrollSubstringTo method

fn scroll_substring_to_point<'life0, 'async_trait>( &'life0 self, start_offset: i32, end_offset: i32, type_: u32, x: i32, y: i32, ) -> Pin<Box<dyn Future<Output = Result<bool, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

ScrollSubstringToPoint method

fn set_caret_offset<'life0, 'async_trait>( &'life0 self, offset: i32, ) -> Pin<Box<dyn Future<Output = Result<bool, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

SetCaretOffset method

fn set_selection<'life0, 'async_trait>( &'life0 self, selection_num: i32, start_offset: i32, end_offset: i32, ) -> Pin<Box<dyn Future<Output = Result<bool, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

SetSelection method

fn caret_offset<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<i32, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

CaretOffset property

fn character_count<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<i32, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

CharacterCount property