Struct DataProviderProxy

pub struct DataProviderProxy { /* private fields */ }

Implementations

impl DataProviderProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.feedback/DataProvider.

pub fn take_event_stream(&self) -> DataProviderEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn get_snapshot( &self, params: GetSnapshotParameters, ) -> QueryResponseFut<Snapshot, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<Option<Box<Screenshot>>, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<Annotations, DefaultFuchsiaResourceDialect>

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 Clone for DataProviderProxy

fn clone(&self) -> DataProviderProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataProviderProxyInterface for DataProviderProxy

type GetSnapshotResponseFut = QueryResponseFut<Snapshot>

type GetScreenshotResponseFut = QueryResponseFut<Option<Box<Screenshot>>>

type GetAnnotationsResponseFut = QueryResponseFut<Annotations>

fn get_snapshot( &self, params: GetSnapshotParameters, ) -> Self::GetSnapshotResponseFut

fn get_screenshot( &self, encoding: ImageEncoding, ) -> Self::GetScreenshotResponseFut

fn get_annotations( &self, params: &GetAnnotationsParameters, ) -> Self::GetAnnotationsResponseFut

impl Debug for DataProviderProxy

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

Formats the value using the given formatter.

impl Proxy for DataProviderProxy

type Protocol = DataProviderMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.