[−][src]Struct futures::channel::mpsc::UnboundedSender
pub struct UnboundedSender<T>(_);
The transmission end of an unbounded mpsc channel.
This value is created by the unbounded function.
Methods
impl<T> UnboundedSender<T>[src][−]
pub fn poll_ready(&self, &mut Context) -> Poll<Result<(), SendError>>[src][+]
Check if the channel is ready to receive a message.
pub fn is_closed(&self) -> bool[src][+]
Returns whether this channel is closed without needing a context.
pub fn close_channel(&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.
pub fn start_send(&mut self, msg: T) -> Result<(), SendError>[src][+]
Send a message on the channel.
This method should only be called after poll_ready has been used to
verify that the channel is ready to receive a message.
pub fn unbounded_send(&self, msg: T) -> Result<(), TrySendError<T>>[src][+]
Sends a message along this channel.
This is an unbounded sender, so this function differs from Sink::send
by ensuring the return type reflects that the channel is always ready to
receive messages.
Trait Implementations
impl<T> Sink<T> for UnboundedSender<T>[src][+]
type SinkError = SendError
The type of value produced by the sink when an error occurs.
fn poll_ready(
self: Pin<&mut UnboundedSender<T>>,
cx: &mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::SinkError>>[src][+]
self: Pin<&mut UnboundedSender<T>>,
cx: &mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::SinkError>>
Attempts to prepare the Sink to receive a value. Read more
fn start_send(
self: Pin<&mut UnboundedSender<T>>,
msg: T
) -> Result<(), <UnboundedSender<T> as Sink<T>>::SinkError>[src][+]
self: Pin<&mut UnboundedSender<T>>,
msg: T
) -> Result<(), <UnboundedSender<T> as Sink<T>>::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 Poll::Ready(Ok(())). Read more
fn poll_flush(
self: Pin<&mut UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::SinkError>>[src][+]
self: Pin<&mut UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::SinkError>>
Flush any remaining output from this sink. Read more
fn poll_close(
self: Pin<&mut UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::SinkError>>[src][+]
self: Pin<&mut UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::SinkError>>
Flush any remaining output and close this sink, if necessary. Read more
impl<'_, T> Sink<T> for &'_ UnboundedSender<T>[src][+]
type SinkError = SendError
The type of value produced by the sink when an error occurs.
fn poll_ready(
self: Pin<&mut &'_ UnboundedSender<T>>,
cx: &mut Context
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::SinkError>>[src][+]
self: Pin<&mut &'_ UnboundedSender<T>>,
cx: &mut Context
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::SinkError>>
Attempts to prepare the Sink to receive a value. Read more
fn start_send(
self: Pin<&mut &'_ UnboundedSender<T>>,
msg: T
) -> Result<(), <&'_ UnboundedSender<T> as Sink<T>>::SinkError>[src][+]
self: Pin<&mut &'_ UnboundedSender<T>>,
msg: T
) -> Result<(), <&'_ UnboundedSender<T> as Sink<T>>::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 Poll::Ready(Ok(())). Read more
fn poll_flush(
self: Pin<&mut &'_ UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::SinkError>>[src][+]
self: Pin<&mut &'_ UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::SinkError>>
Flush any remaining output from this sink. Read more
fn poll_close(
self: Pin<&mut &'_ UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::SinkError>>[src][+]
self: Pin<&mut &'_ UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::SinkError>>
Flush any remaining output and close this sink, if necessary. Read more
impl<T> Clone for UnboundedSender<T>[src][+]
fn clone(&self) -> UnboundedSender<T>[src][+]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src][+]
Performs copy-assignment from source. Read more
impl<T> Debug for UnboundedSender<T> where
T: Debug, [src][+]
T: Debug,
Auto Trait Implementations
impl<T> Send for UnboundedSender<T> where
T: Send,
T: Send,
impl<T> Sync for UnboundedSender<T> where
T: Send,
T: Send,
Blanket Implementations
impl<T> From for T[src][+]
impl<T, U> Into for T where
U: From<T>, [src][+]
U: From<T>,
impl<T> ToOwned for T where
T: Clone, [src][+]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T[src][+]
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)[src][+]
🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
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][+]
Performs the conversion.
impl<T> Borrow for T where
T: ?Sized, [src][+]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow(&self) -> &T[src][+]
Immutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized, [src][+]
T: 'static + ?Sized,
fn type_id(&self) -> TypeId[src][+]
Gets the TypeId of self. Read more
impl<T> BorrowMut for T where
T: ?Sized, [src][+]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T[src][+]
Mutably borrows from an owned value. Read more
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][+]
Performs the conversion.
impl<T, Item> SinkExt for T where
T: Sink<Item> + ?Sized, [src][+]
T: Sink<Item> + ?Sized,
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
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][+]
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::SinkError>>,
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][+]
F: FnOnce(Self::SinkError) -> E,
Transforms the error returned by the sink.
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
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>fn close(&mut self) -> Close<Self, Item> where
Self: Unpin, [src][+]
Self: Unpin,
Close the sink.
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>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>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>fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
Self: Unpin,
St: Stream<Item = Item> + Unpin, [src][+]
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
ⓘImportant traits for Either<A, B>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
ⓘImportant traits for Either<A, B>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
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