Struct websocket::async::futures::sink::Wait

#[must_use = "sinks do nothing unless used"]
pub struct Wait<S> { /* fields omitted */ }

A sink combinator which converts an asynchronous sink to a blocking sink.

Created by the Sink::wait method, this function transforms any sink into a blocking version. This is implemented by blocking the current thread when a sink is otherwise unable to make progress.

Methods

impl<S> Wait<S> where     S: Sink,

pub fn send(     &mut self,     value: <S as Sink>::SinkItem ) -> Result<(), <S as Sink>::SinkError>

Sends a value to this sink, blocking the current thread until it's able to do so.

This function will take the value provided and call the underlying sink's start_send function until it's ready to accept the value. If the function returns NotReady then the current thread is blocked until it is otherwise ready to accept the value.

Return value

If Ok(()) is returned then the value provided was successfully sent along the sink, and if Err(e) is returned then an error occurred which prevented the value from being sent.

pub fn flush(&mut self) -> Result<(), <S as Sink>::SinkError>

Flushes any buffered data in this sink, blocking the current thread until it's entirely flushed.

This function will call the underlying sink's poll_complete method until it returns that it's ready to proceed. If the method returns NotReady the current thread will be blocked until it's otherwise ready to proceed.

pub fn close(&mut self) -> Result<(), <S as Sink>::SinkError>

Close this sink, blocking the current thread until it's entirely closed.

This function will call the underlying sink's close method until it returns that it's closed. If the method returns NotReady the current thread will be blocked until it's otherwise closed.

Trait Implementations

impl<S> Debug for Wait<S> where     S: Debug,

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

Formats the value using the given formatter.