[−][src]Struct futures::channel::mpsc::Sender

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]
[−]

pub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<T>>
[src]
[−]

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]
[−]

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, lw: &LocalWaker) -> Poll<Result<(), SendError>>
[src]
[−]

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]
[−]

Returns whether this channel is closed without needing a context.

pub fn close_channel(&mut self)
[src]
[−]

Closes this channel from the sender side, preventing any new messages.

Trait Implementations

impl<T> Unpin for Sender<T>
[src]

impl<T> Debug for Sender<T> where
    T: Debug, 
[src]
[+]

impl<T> Drop for Sender<T>
[src]
[+]

impl<T> Clone for Sender<T>
[src]
[+]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]
[−]

Performs copy-assignment from source. Read more

impl<T> Sink for Sender<T>
[src]
[+]

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.

Auto Trait Implementations

impl<T> Send for Sender<T> where
    T: Send, 

impl<T> Sync for Sender<T> where
    T: Send, 

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone, 
[src]
[−]

type Owned = T

impl<T> From for T
[src]
[−]

impl<T, U> Into for T where
    U: From<T>, 
[src]
[−]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]
[−]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized, 
[src]
[−]

impl<T> Any for T where
    T: 'static + ?Sized, 
[src]
[−]

impl<T> BorrowMut for T where
    T: ?Sized, 
[src]
[−]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]
[−]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> SinkExt for T where
    T: Sink + ?Sized, 
[src]
[−]

fn with<U, Fut, F, E>(self, f: F) -> With<Self, U, Fut, F> where
    E: From<Self::SinkError>,
    F: FnMut(U) -> Fut,
    Fut: Future<Output = Result<Self::SinkItem, E>>, 
[src]
[−]

Composes a function in front of the sink. Read more

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, U, St, F> where
    F: FnMut(U) -> St,
    St: Stream<Item = Result<Self::SinkItem, Self::SinkError>>, 
[src]
[−]

Composes a function in front of the sink. Read more

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
    F: FnOnce(Self::SinkError) -> E, 
[src]
[−]

Transforms the error returned by the sink.

fn sink_err_into<E>(self) -> SinkErrInto<Self, E> where
    Self::SinkError: Into<E>, 
[src]
[−]

Map this sink's error to a different error type using the Into trait. Read more

fn buffer(self, capacity: usize) -> Buffer<Self>
[src]
[−]

Adds a fixed-size buffer to the current sink. Read more

fn close(&mut self) -> Close<Self> where
    Self: Unpin, 
[src]
[−]

Close the sink.

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
    Si: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
    Self::SinkItem: Clone, 
[src]
[−]

Fanout items to multiple sinks. Read more

fn flush(&mut self) -> Flush<Self> where
    Self: Unpin, 
[src]
[−]

Flush the sync, processing all pending items. Read more

fn send(&mut self, item: Self::SinkItem) -> Send<Self> where
    Self: Unpin, 
[src]
[−]

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
    Self: Unpin,
    St: Stream<Item = Self::SinkItem> + Unpin, 
[src]
[−]

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

fn left_sink<Si2>(self) -> Either<Self, Si2> where
    Si2: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, 
[src]
[−]

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

fn right_sink<Si1>(self) -> Either<Si1, Self> where
    Si1: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, 
[src]
[−]

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

ⓘImportant traits for Compat<R>
fn compat(self) -> Compat<Self> where
    Self: Unpin, 
[src]
[−]

Wraps a [Sink] into a sink compatible with libraries using futures 0.1 Sink. Requires the compat feature to be enabled. Read more