Struct atspi_proxies::socket::SocketProxy

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

Implementations

impl<'p> SocketProxy<'p>

pub async fn new(conn: &Connection) -> Result<SocketProxy<'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 embed(&self, plug: &(&str, ObjectPath<'_>)) -> Result<ObjectRef>

@plug: a string for the unique bus name of the application, and an object path for the application’s’ root object.

This is the entry point for an application that wants to register itself against the accessibility registry. The application’s root object, which it passes in @plug, must support the org.a11y.atspi.Application interface.

When an application calls this method on the registry, the following handshake happens:

• Application calls this method on the registry to identify itself.
• The registry sets the “Id” property on the org.a11y.atspi.Application interface on the @plug object.
• The Embed method returns with the bus name and object path for the registry’s root object. Returns: the bus name and object path of the registry’s root object.

pub async fn embedded(&self, path: ObjectPath<'_>) -> Result<()>

This method is called by a socket to inform the plug that it is being embedded. The plug should register the embedding socket as its parent.

pub async fn unembed(&self, plug: &(&str, ObjectPath<'_>)) -> Result<()>

Unembed method @plug: a string for the unique bus name of the application, and an object path for the application’s’ root object.

Unregisters an application from the accesibility registry. It is not necessary to call this method; the accessibility registry detects when an application disconnects from the bus.

Trait Implementations

impl<'p> AsMut<Proxy<'p>> for SocketProxy<'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 SocketProxy<'p>

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

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

impl<'p> Clone for SocketProxy<'p>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'p> Debug for SocketProxy<'p>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl<'a> ProxyDefault for SocketProxy<'a>

const INTERFACE: Option<&'static str> = _

const DESTINATION: Option<&'static str> = _

const PATH: Option<&'static str> = _

impl<'p> ProxyImpl<'p> for SocketProxy<'p>

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

Returns a customizable builder for this proxy.

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

Consumes self, returning the underlying zbus::Proxy.

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

The reference to the underlying zbus::Proxy.

impl<'p> Serialize for SocketProxy<'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 SocketProxy<'p>

fn signature() -> Signature<'static>

Get the signature for the implementing type.