Struct SetupSynchronousProxy

pub struct SetupSynchronousProxy { /* private fields */ }

Implementations

impl SetupSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<SetupEvent, 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_view_refs( &self, ___deadline: MonotonicInstant, ) -> Result<(ViewRef, ViewRef), Error>

Returns the viewrefs for injection authority (Config.context) and injection destination (Config.target).

This only returns when valid context and target views exist. Typically called just once.

pub fn watch_viewport( &self, ___deadline: MonotonicInstant, ) -> Result<Viewport, Error>

Returns the current viewport. Follows the hanging get pattern.

The first call to this function will return the current viewport, whenever one exists. Subsequent calls will block until the viewport has been updated.

Flow control: There should only be one outstanding call to this function. The channel will be closed if an additional call to this function is made while a call is outstanding.

Trait Implementations

impl Debug for SetupSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for SetupSynchronousProxy

type Proxy = SetupProxy

The async proxy for the same protocol.

type Protocol = SetupMarker

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.