[−][src]Struct futures::channel::mpsc::Sender
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, cx: &mut Context) -> 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(Poll::Ready(_))if there is sufficient capacity;Ok(Poll::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.
pub fn disconnect(&mut self)[src]
Disconnects this sender from the channel, closing it if there are no more senders left.
Trait Implementations
impl<T> Debug for Sender<T> where
T: Debug, [src]
T: Debug,
impl<T> Clone for Sender<T>[src]
fn clone(&self) -> Sender<T>[src]
default fn clone_from(&mut self, source: &Self)1.0.0[src]
Performs copy-assignment from source. Read more
impl<T> Sink<T> for Sender<T>[src]
type SinkError = SendError
The type of value produced by the sink when an error occurs.
fn poll_ready(
self: Pin<&mut Sender<T>>,
cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::SinkError>>[src]
self: Pin<&mut Sender<T>>,
cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::SinkError>>
fn start_send(
self: Pin<&mut Sender<T>>,
msg: T
) -> Result<(), <Sender<T> as Sink<T>>::SinkError>[src]
self: Pin<&mut Sender<T>>,
msg: T
) -> Result<(), <Sender<T> as Sink<T>>::SinkError>
fn poll_flush(
self: Pin<&mut Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::SinkError>>[src]
self: Pin<&mut Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::SinkError>>
fn poll_close(
self: Pin<&mut Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::SinkError>>[src]
self: Pin<&mut Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::SinkError>>
Auto Trait Implementations
Blanket Implementations
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
impl<T> From for T[src]
impl<T, U> Into for T where
U: From<T>, [src]
U: From<T>,
impl<T, U> TryFrom for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T> Borrow for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized, [src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T[src]
impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T, Item> SinkExt for T where
T: Sink<Item> + ?Sized, [src]
T: Sink<Item> + ?Sized,
default fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
E: From<Self::SinkError>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>, [src]
E: From<Self::SinkError>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
Composes a function in front of the sink. Read more
default fn with_flat_map<U, St, F>(
self,
f: F
) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::SinkError>>, [src]
self,
f: F
) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::SinkError>>,
Composes a function in front of the sink. Read more
default fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E, [src]
F: FnOnce(Self::SinkError) -> E,
Transforms the error returned by the sink.
default fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::SinkError: Into<E>, [src]
Self::SinkError: Into<E>,
Map this sink's error to a different error type using the Into trait. Read more
default fn buffer(self, capacity: usize) -> Buffer<Self, Item>[src]
Adds a fixed-size buffer to the current sink. Read more
ⓘImportant traits for Close<'_, Si, Item>default fn close(&mut self) -> Close<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
Close the sink.
default fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, SinkError = Self::SinkError>, [src]
Item: Clone,
Si: Sink<Item, SinkError = Self::SinkError>,
Fanout items to multiple sinks. Read more
ⓘImportant traits for Flush<'_, Si, Item>default fn flush(&mut self) -> Flush<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
Flush the sync, processing all pending items. Read more
ⓘImportant traits for Send<'_, Si, Item>default fn send(&mut self, item: Item) -> Send<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
A future that completes after the given item has been fully processed into the sink, including flushing. Read more
ⓘImportant traits for SendAll<'_, Si, St>default fn send_all<St>(
&'a mut self,
stream: &'a mut St
) -> SendAll<'a, Self, St> where
Self: Unpin,
St: Stream<Item = Item> + Unpin, [src]
&'a mut self,
stream: &'a mut St
) -> SendAll<'a, Self, St> where
Self: Unpin,
St: Stream<Item = Item> + Unpin,
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
default fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, SinkError = Self::SinkError>, [src]
Si2: Sink<Item, SinkError = Self::SinkError>,
Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more
default fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, SinkError = Self::SinkError>, [src]
Si1: Sink<Item, SinkError = Self::SinkError>,
Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more
default fn compat(self) -> CompatSink<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
Wraps a [Sink] into a sink compatible with libraries using futures 0.1 Sink. Requires the compat feature to be enabled. Read more