Struct futures::channel::mpsc::Sender [−][src]
pub struct Sender<T> { /* fields omitted */ }The transmission end of a bounded mpsc channel.
This value is created by the channel function.
Methods
impl<T> Sender<T>[src]
impl<T> Sender<T>pub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<T>>[src]
pub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<T>>Attempts to send a message on this Sender, returning the message
if there was an error.
pub fn start_send(&mut self, msg: T) -> Result<(), SendError>[src]
pub fn start_send(&mut self, msg: T) -> Result<(), SendError>Send a message on the channel.
This function should only be called after
poll_ready has reported that the channel is
ready to receive a message.
pub fn poll_ready(&mut self, cx: &mut Context) -> Poll<Result<(), SendError>>[src]
pub fn poll_ready(&mut self, cx: &mut Context) -> Poll<Result<(), SendError>>Polls the channel to determine if there is guaranteed capacity to send at least one item without waiting.
Return value
This method returns:
Ok(Async::Ready(_))if there is sufficient capacity;Ok(Async::Pending)if the channel may not have capacity, in which case the current task is queued to be notified once capacity is available;Err(SendError)if the receiver has been dropped.
pub fn is_closed(&self) -> bool[src]
pub fn is_closed(&self) -> boolReturns whether this channel is closed without needing a context.
pub fn close_channel(&mut self)[src]
pub fn close_channel(&mut self)Closes this channel from the sender side, preventing any new messages.
Trait Implementations
impl<T> Sink for Sender<T>[src]
impl<T> Sink for Sender<T>type SinkItem = T
The type of value that the sink accepts.
type SinkError = SendError
The type of value produced by the sink when an error occurs.
fn poll_ready(
self: PinMut<Sender<T>>,
cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink>::SinkError>>[src]
fn poll_ready(
self: PinMut<Sender<T>>,
cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink>::SinkError>>Attempts to prepare the Sink to receive a value. Read more
fn start_send(
self: PinMut<Sender<T>>,
msg: T
) -> Result<(), <Sender<T> as Sink>::SinkError>[src]
fn start_send(
self: PinMut<Sender<T>>,
msg: T
) -> Result<(), <Sender<T> as Sink>::SinkError>Begin the process of sending a value to the sink. Each call to this function must be proceeded by a successful call to poll_ready which returned Ok(Poll::Ready(())). Read more
fn poll_flush(
self: PinMut<Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink>::SinkError>>[src]
fn poll_flush(
self: PinMut<Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink>::SinkError>>Flush any remaining output from this sink. Read more
fn poll_close(
self: PinMut<Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink>::SinkError>>[src]
fn poll_close(
self: PinMut<Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink>::SinkError>>Flush any remaining output and close this sink, if necessary. Read more
impl<T> Drop for Sender<T>[src]
impl<T> Drop for Sender<T>impl<T> Debug for Sender<T> where
T: Debug, [src]
impl<T> Debug for Sender<T> where
T: Debug, fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>Formats the value using the given formatter. Read more
impl<T> Clone for Sender<T>[src]
impl<T> Clone for Sender<T>fn clone(&self) -> Sender<T>[src]
fn clone(&self) -> Sender<T>Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl<T> Unpin for Sender<T>[src]
impl<T> Unpin for Sender<T>