Enum ObjectRef 

pub enum ObjectRef<'o> {
    Null,
    Owned {
        name: UniqueName<'static>,
        path: ObjectPath<'static>,
    },
    Borrowed {
        name: UniqueName<'o>,
        path: ObjectPath<'o>,
    },
}

A unique identifier for an object in the accessibility tree.

A ubiquitous type used to refer to an object in the accessibility tree.

In AT-SPI2, objects in the applications’ UI object tree are uniquely identified using an application’s bus name and object path. “(so)”

Emitted by RemoveAccessible and Available

Variants

Null

Owned

Fields

name: UniqueName<'static>

path: ObjectPath<'static>

Borrowed

Fields

name: UniqueName<'o>

path: ObjectPath<'o>

Implementations

impl<'o> ObjectRef<'o>

pub fn new(name: UniqueName<'o>, path: ObjectPath<'o>) -> Self

Create a new ObjectRef::Borrowed from a UniqueName and ObjectPath.

pub fn new_owned<N, P>(name: N, path: P) -> ObjectRefOwned

where N: Into<UniqueName<'static>>, P: Into<ObjectPath<'static>>,

Create a new, owned ObjectRef.

Example

use zbus::names::UniqueName;
use zbus::zvariant::ObjectPath;
use atspi_common::ObjectRef;

let name = UniqueName::from_static_str_unchecked(":1.23");
let path = ObjectPath::from_static_str_unchecked("/org/a11y/example/path/007");

let object_ref = ObjectRef::new_owned(name, path);

pub fn new_borrowed<N, P>(name: N, path: P) -> ObjectRef<'o>

where N: Into<UniqueName<'o>>, P: Into<ObjectPath<'o>>,

Create a new, borrowed ObjectRef.

Example

use zbus::names::UniqueName;
use zbus::zvariant::ObjectPath;
use atspi_common::ObjectRef;

let name = UniqueName::from_static_str_unchecked(":1.23");
let path = ObjectPath::from_static_str_unchecked("/org/a11y/example/path/007");

let object_ref = ObjectRef::new_borrowed(name, path);

pub fn try_from_bus_name_and_path( sender: BusName<'o>, path: ObjectPath<'o>, ) -> Result<Self, AtspiError>

Create a new ObjectRef, from BusName and ObjectPath.

Errors

Will fail if the sender is not a UniqueName.

pub const fn from_static_str_unchecked( name: &'static str, path: &'static str, ) -> Self

Create a new ObjectRef, unchecked.

Safety

The caller must ensure that the strings are valid.

pub fn is_null(&self) -> bool

Returns true if the object reference is Null, otherwise returns false.

Toolkits may use the Null object reference to indicate that an object is not available or does not exist. For example, when calling Accessible::get_parent on an object that has no parent, it may return a Null object reference.

pub fn name(&self) -> Option<&UniqueName<'o>>

Returns the name of the object reference. If the object reference is Null, it returns None. If the object reference is Owned or Borrowed, it returns the name.

Example

use zbus::names::UniqueName;
use zbus::zvariant::ObjectPath;
use atspi_common::ObjectRef;

let name = UniqueName::from_static_str_unchecked(":1.23");
let path = ObjectPath::from_static_str_unchecked("/org/a11y/example/path/007");
let object_ref = ObjectRef::new_borrowed(name, path);

// Check the name of the object reference
assert!(object_ref.name().is_some());
assert_eq!(object_ref.name().unwrap().as_str(), ":1.23");

pub fn path(&self) -> &ObjectPath<'o>

Returns the path of the object reference.\

Example

use zbus::names::UniqueName;
use zbus::zvariant::ObjectPath;
use atspi_common::ObjectRef;

let name = UniqueName::from_static_str_unchecked(":1.23");
let path = ObjectPath::from_static_str_unchecked("/org/a11y/example/path/007");
let object_ref = ObjectRef::new_borrowed(name, path);

// Check the path of the object reference
assert_eq!(object_ref.path().as_str(), "/org/a11y/example/path/007");

pub fn into_owned(self) -> ObjectRef<'static>

Converts the ObjectRef into an owned instance, consuming self.
If the object reference is Null, it returns ObjectRef::Null.
If the object reference is Owned, it returns the same ObjectRef::Owned.
If the object reference is Borrowed, it converts the name and path to owned versions and returns ObjectRef::Owned.

Extending lifetime ‘magic’ (from ’o -> ‘static’)

ObjectRef<'_> leans on the implementation of UniqueName and ObjectPath to convert the inner types to 'static. These types have an Inner enum that can contain an Owned, Borrowed, or Static Str type. The Strtype is either a &'static str (static), &str (borrowed), or an Arc<str> (owned).

Example

use zbus::names::UniqueName;
use zbus::zvariant::ObjectPath;
use atspi_common::ObjectRef;

let name = UniqueName::from_static_str_unchecked(":1.23");
let path = ObjectPath::from_static_str_unchecked("/org/a11y/example/path/007");
let object_ref = ObjectRef::new_borrowed(name, path);

// Check whether the object reference can be converted to an owned version
assert!(!object_ref.is_null());
let object_ref = object_ref.into_owned();
assert!(matches!(object_ref, ObjectRef::Owned { .. }));

pub fn name_as_str(&self) -> Option<&str>

Returns the name of the object reference as a string slice.

pub fn path_as_str(&self) -> &str

Returns the path of the object reference as a string slice.

Trait Implementations

impl<'o> Clone for ObjectRef<'o>

fn clone(&self) -> ObjectRef<'o>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'o> Debug for ObjectRef<'o>

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

Formats the value using the given formatter.

impl Default for ObjectRef<'_>

fn default() -> Self

Returns a Null object reference.

impl<'de: 'o, 'o> Deserialize<'de> for ObjectRef<'o>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

ObjectRef’s wire format is (&str, ObjectPath). An empty &str with a “/org/a11y/atspi/null” path is considered a Null object, this is deserialized as ObjectRef::Null.
Any other valid (&str, ObjectPath) will deserialize into ObjectRef::Borrowed.

impl<'reference: 'structure, 'object: 'structure, 'structure> From<&'reference ObjectRef<'object>> for Structure<'structure>

fn from(obj: &'reference ObjectRef<'object>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ActivateEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ApplicationChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for AttributesChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for AttributesChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for BoundsChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for CharWidthChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for CloseEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ColumnCountChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ColumnDeletedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ColumnInsertedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ColumnReorderedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ContentChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for CreateEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for DeactivateEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for DesktopCreateEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for DesktopDestroyEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for DestroyEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for FocusEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for LineChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for LineCountChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for LinkSelectedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for LoadCompleteEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for LoadStoppedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for LowerEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for MaximizeEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for MinimizeEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ModelChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for MoveEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ObjectRefOwned

fn from(object_ref: ObjectRef<'_>) -> Self

Convert an ObjectRef<'_> into an ObjectRefOwned.

Extending lifetime ‘magic’ (from ’o -> ‘static’)

ObjectRef<'_> leans on the implementation of UniqueName and ObjectPath to convert the inner types to 'static. These types have an Inner enum that can contain an Owned, Borrowed, or Static Str type. The Strtype is either a &'static str (static), &str (borrowed), or an Arc<str> (owned).

impl From<ObjectRef<'_>> for PageChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for RaiseEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ReloadEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ReparentEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ResizeEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for RestoreEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for RestyleEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for RowDeletedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for RowInsertedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for RowReorderedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for SelectionChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for ShadeEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for TextAttributesChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for TextBoundsChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for TextSelectionChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for UUshadeEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl From<ObjectRef<'_>> for VisibleDataChangedEvent

fn from(obj_ref: ObjectRef<'_>) -> Self

Converts to this type from the input type.

impl<'o> From<ObjectRef<'o>> for Structure<'o>

fn from(obj: ObjectRef<'o>) -> Self

Converts to this type from the input type.

impl Hash for ObjectRef<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> MessageConversionExt<'a, ObjectRef<'a>> for AvailableEvent

fn try_from_message(msg: &Message, hdr: &Header<'_>) -> Result<Self, AtspiError>

Convert a zbus::Message into this event type. Does all the validation for you.

fn validate_interface(header: &Header<'_>) -> Result<(), AtspiError>

Validate the interface string via zbus::message::Header::interface against Self’s assignment of DBusInterface::DBUS_INTERFACE

fn validate_member(hdr: &Header<'_>) -> Result<(), AtspiError>

Validate the member string via zbus::message::Header::member against Self’s assignment of DBusMember::DBUS_MEMBER

fn validate_body(msg: &Message) -> Result<(), AtspiError>

Validate the body signature against the zvariant::Signature of MessageConversion::Body

impl PartialEq<ObjectRef<'_>> for ObjectRefOwned

fn eq(&self, other: &ObjectRef<'_>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ObjectRefOwned> for ObjectRef<'_>

fn eq(&self, other: &ObjectRefOwned) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ObjectRef<'_>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ObjectRef<'_>

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

where S: Serializer,

ObjectRef’s wire format is (&str, ObjectPath). The Null variant, the “Null object”, is serialized as ("", ObjectPath("/org/a11y/atspi/null")). Both Owned and Borrowed variants are serialized as (&str, ObjectPath) with the object’s
unique name and path.

impl<'m: 'o, 'o> TryFrom<&'m Header<'_>> for ObjectRef<'o>

fn try_from(header: &'m Header<'_>) -> Result<Self, Self::Error>

Construct an ObjectRef from a zbus::message::Header.

Header fields

Path is a mandatory field on method calls and signals, Sender is an optional field, see: DBus specification - header fields).,

 On a message bus, this header field is controlled by the message bus,
 so it is as reliable and trustworthy as the message bus itself.
 Otherwise, (eg. P2P) this header field is controlled by the message sender,
 unless there is out-of-band information that indicates otherwise.

While unlikely, it is possible that Sender or Path are not set on the header. This could happen if the server implementation does not set these fields for any reason.

Errors

Will return an AtspiError::ParseError if the header does not contain a valid path or sender.

type Error = AtspiError

The type returned in the event of a conversion error.

impl TryFrom<OwnedValue> for ObjectRef<'static>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: OwnedValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<'v> TryFrom<Value<'v>> for ObjectRef<'v>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'v>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'o> Type for ObjectRef<'o>

const SIGNATURE: &'static Signature

The signature for the implementing type, in parsed format.

impl<'o> Eq for ObjectRef<'o>