Struct DataProviderSynchronousProxy

pub struct DataProviderSynchronousProxy { /* private fields */ }

Implementations

impl DataProviderSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<DataProviderEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn get_snapshot( &self, params: GetSnapshotParameters, ___deadline: MonotonicInstant, ) -> Result<Snapshot, Error>

Returns a snapshot of the device’s state.

snapshot may be empty if there was an issue generating the snapshot.

pub fn get_screenshot( &self, encoding: ImageEncoding, ___deadline: MonotonicInstant, ) -> Result<Option<Box<Screenshot>>, Error>

Returns an image of the current view encoded in the provided encoding.

screenshot may be null if the encoding is not supported, the device does not have a display, or there is not enough memory to allocate the screenshot image.

The screenshot is provided separately from the snapshot as callers might want to block on this call before changing the view while collecting a snapshot in the background is fine. There are also a lot of clients that are not interested in the screenshot.

pub fn get_annotations( &self, params: &GetAnnotationsParameters, ___deadline: MonotonicInstant, ) -> Result<Annotations, Error>

Returns a set of annotations about the device’s state.

annotations may be empty if there was an issue collecting them.

These are the same annotations as provided through GetSnapshot() - some clients only want the annotations while others want both the annotations and the snapshot and generating the snapshot can take significantly more time than collecting the annotations, e.g., logs are only part of the snapshot and not part of the annotations and can take some time.

Trait Implementations

impl Debug for DataProviderSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for DataProviderSynchronousProxy

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<DataProviderSynchronousProxy> for Handle

fn from(value: DataProviderSynchronousProxy) -> Self

Converts to this type from the input type.

impl SynchronousProxy for DataProviderSynchronousProxy

type Proxy = DataProviderProxy

The async proxy for the same protocol.

type Protocol = DataProviderMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.