Struct Proxy

pub struct Proxy<T>
where
    T: 'static,
{ /* private fields */ }

An event loop proxy with backpressure that implements Sink.

Implementations

impl<T> Proxy<T>

where T: 'static,

pub fn new( raw: EventLoopProxy, event_sender: UnboundedSender<Event<T>>, ) -> (Proxy<T>, impl Future<Output = ()>)

Creates a new Proxy from an EventLoopProxy.

pub fn send(&mut self, value: T)

where T: Debug,

Sends a value to the event loop.

Note: This skips the backpressure mechanism with an unbounded channel. Use sparingly!

pub fn send_action(&mut self, action: Action<T>)

where T: Debug,

Sends an action to the event loop.

Note: This skips the backpressure mechanism with an unbounded channel. Use sparingly!

pub fn free_slots(&mut self, amount: usize)

Frees an amount of slots for additional messages to be queued in this Proxy.

Trait Implementations

impl<T> Clone for Proxy<T>

where T: 'static,

fn clone(&self) -> Proxy<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Proxy<T>

where T: Debug + 'static,

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

Formats the value using the given formatter.

impl<T> Sink<Action<T>> for Proxy<T>

where T: 'static,

type Error = SendError

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Proxy<T>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Proxy<T> as Sink<Action<T>>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Proxy<T>>, action: Action<T>, ) -> Result<(), <Proxy<T> as Sink<Action<T>>>::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Proxy<T>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Proxy<T> as Sink<Action<T>>>::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Proxy<T>>, _cx: &mut Context<'_>, ) -> Poll<Result<(), <Proxy<T> as Sink<Action<T>>>::Error>>

Flush any remaining output and close this sink, if necessary.