pub struct UnboundedSender<T>(_);Expand description
The transmission end of an unbounded mpsc channel.
This value is created by the unbounded function.
Implementations
sourceimpl<T> UnboundedSender<T>
impl<T> UnboundedSender<T>
sourcepub fn poll_ready(&self, &mut Context<'_>) -> Poll<Result<(), SendError>>
pub fn poll_ready(&self, &mut Context<'_>) -> Poll<Result<(), SendError>>
Check if the channel is ready to receive a message.
sourcepub fn is_closed(&self) -> bool
pub fn is_closed(&self) -> bool
Returns whether this channel is closed without needing a context.
sourcepub fn close_channel(&self)
pub fn close_channel(&self)
Closes this channel from the sender side, preventing any new messages.
sourcepub fn disconnect(&mut self)
pub fn disconnect(&mut self)
Disconnects this sender from the channel, closing it if there are no more senders left.
sourcepub fn start_send(&mut self, msg: T) -> Result<(), SendError>
pub fn start_send(&mut self, msg: T) -> Result<(), SendError>
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.
sourcepub fn unbounded_send(&self, msg: T) -> Result<(), TrySendError<T>>
pub fn unbounded_send(&self, msg: T) -> Result<(), TrySendError<T>>
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.
sourcepub fn same_receiver(&self, other: &UnboundedSender<T>) -> bool
pub fn same_receiver(&self, other: &UnboundedSender<T>) -> bool
Returns whether the senders send to the same receiver.
sourcepub fn is_connected_to(&self, receiver: &UnboundedReceiver<T>) -> bool
pub fn is_connected_to(&self, receiver: &UnboundedReceiver<T>) -> bool
Returns whether the sender send to this receiver.
sourcepub fn hash_receiver<H>(&self, hasher: &mut H) where
H: Hasher,
pub fn hash_receiver<H>(&self, hasher: &mut H) where
H: Hasher,
Hashes the receiver into the provided hasher
Trait Implementations
sourceimpl<T> Clone for UnboundedSender<T>
impl<T> Clone for UnboundedSender<T>
sourcefn clone(&self) -> UnboundedSender<T>
fn clone(&self) -> UnboundedSender<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl<T> Debug for UnboundedSender<T> where
T: Debug,
impl<T> Debug for UnboundedSender<T> where
T: Debug,
sourceimpl<T> Sink<T> for UnboundedSender<T>
impl<T> Sink<T> for UnboundedSender<T>
sourcefn poll_ready(
self: Pin<&mut UnboundedSender<T>>,
cx: &mut Context<'_>
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::Error>>
fn poll_ready(
self: Pin<&mut UnboundedSender<T>>,
cx: &mut Context<'_>
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::Error>>
Attempts to prepare the Sink to receive a value. Read more
sourcefn start_send(
self: Pin<&mut UnboundedSender<T>>,
msg: T
) -> Result<(), <UnboundedSender<T> as Sink<T>>::Error>
fn start_send(
self: Pin<&mut UnboundedSender<T>>,
msg: T
) -> Result<(), <UnboundedSender<T> as Sink<T>>::Error>
Begin the process of sending a value to the sink.
Each call to this function must be preceded by a successful call to
poll_ready which returned Poll::Ready(Ok(())). Read more
sourcefn poll_flush(
self: Pin<&mut UnboundedSender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::Error>>
fn poll_flush(
self: Pin<&mut UnboundedSender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::Error>>
Flush any remaining output from this sink. Read more
sourcefn poll_close(
self: Pin<&mut UnboundedSender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::Error>>
fn poll_close(
self: Pin<&mut UnboundedSender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <UnboundedSender<T> as Sink<T>>::Error>>
Flush any remaining output and close this sink, if necessary. Read more
sourceimpl<'_, T> Sink<T> for &'_ UnboundedSender<T>
impl<'_, T> Sink<T> for &'_ UnboundedSender<T>
sourcefn poll_ready(
self: Pin<&mut &'_ UnboundedSender<T>>,
cx: &mut Context<'_>
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>>
fn poll_ready(
self: Pin<&mut &'_ UnboundedSender<T>>,
cx: &mut Context<'_>
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>>
Attempts to prepare the Sink to receive a value. Read more
sourcefn start_send(
self: Pin<&mut &'_ UnboundedSender<T>>,
msg: T
) -> Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>
fn start_send(
self: Pin<&mut &'_ UnboundedSender<T>>,
msg: T
) -> Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>
Begin the process of sending a value to the sink.
Each call to this function must be preceded by a successful call to
poll_ready which returned Poll::Ready(Ok(())). Read more
sourcefn poll_flush(
self: Pin<&mut &'_ UnboundedSender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>>
fn poll_flush(
self: Pin<&mut &'_ UnboundedSender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>>
Flush any remaining output from this sink. Read more
sourcefn poll_close(
self: Pin<&mut &'_ UnboundedSender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>>
fn poll_close(
self: Pin<&mut &'_ UnboundedSender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <&'_ UnboundedSender<T> as Sink<T>>::Error>>
Flush any remaining output and close this sink, if necessary. Read more
Auto Trait Implementations
impl<T> !RefUnwindSafe for UnboundedSender<T>
impl<T> Send for UnboundedSender<T> where
T: Send,
impl<T> Sync for UnboundedSender<T> where
T: Send,
impl<T> Unpin for UnboundedSender<T>
impl<T> !UnwindSafe for UnboundedSender<T>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
sourcefn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,
Composes a function in front of the sink. Read more
sourcefn 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::Error>>,
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::Error>>,
Composes a function in front of the sink. Read more
sourcefn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Transforms the error returned by the sink.
sourcefn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
Map this sink’s error to a different error type using the Into trait. Read more
sourcefn buffer(self, capacity: usize) -> Buffer<Self, Item>
fn buffer(self, capacity: usize) -> Buffer<Self, Item>
Adds a fixed-size buffer to the current sink. Read more
sourcefn close(&mut self) -> Close<'_, Self, Item>ⓘNotable traits for Close<'_, Si, Item>impl<'_, Si, Item> Future for Close<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where
Self: Unpin,
fn close(&mut self) -> Close<'_, Self, Item>ⓘNotable traits for Close<'_, Si, Item>impl<'_, Si, Item> Future for Close<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where
Self: Unpin,
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;
Close the sink.
sourcefn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
Fanout items to multiple sinks. Read more
sourcefn flush(&mut self) -> Flush<'_, Self, Item>ⓘNotable traits for Flush<'_, Si, Item>impl<'_, Si, Item> Future for Flush<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where
Self: Unpin,
fn flush(&mut self) -> Flush<'_, Self, Item>ⓘNotable traits for Flush<'_, Si, Item>impl<'_, Si, Item> Future for Flush<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where
Self: Unpin,
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;
Flush the sink, processing all pending items. Read more
sourcefn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘNotable traits for Send<'_, Si, Item>impl<'_, Si, Item> Future for Send<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where
Self: Unpin,
fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘNotable traits for Send<'_, Si, Item>impl<'_, Si, Item> Future for Send<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where
Self: Unpin,
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;
A future that completes after the given item has been fully processed into the sink, including flushing. Read more
sourcefn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘNotable traits for Feed<'_, Si, Item>impl<'_, Si, Item> Future for Feed<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where
Self: Unpin,
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘNotable traits for Feed<'_, Si, Item>impl<'_, Si, Item> Future for Feed<'_, Si, Item> where
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where
Self: Unpin,
Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;
A future that completes after the given item has been received by the sink. Read more
sourcefn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>ⓘNotable traits for SendAll<'_, Si, St>impl<'_, Si, St, Ok, Error> Future for SendAll<'_, Si, St> where
Si: Sink<Ok, Error = Error> + Unpin + ?Sized,
St: Stream<Item = Result<Ok, Error>> + Unpin + ?Sized, type Output = Result<(), Error>; where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>ⓘNotable traits for SendAll<'_, Si, St>impl<'_, Si, St, Ok, Error> Future for SendAll<'_, Si, St> where
Si: Sink<Ok, Error = Error> + Unpin + ?Sized,
St: Stream<Item = Result<Ok, Error>> + Unpin + ?Sized, type Output = Result<(), Error>; where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,
Si: Sink<Ok, Error = Error> + Unpin + ?Sized,
St: Stream<Item = Result<Ok, Error>> + Unpin + ?Sized, type Output = Result<(), Error>;
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
sourcefn left_sink<Si2>(self) -> Either<Self, Si2>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where
A: Future,
B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where
Si2: Sink<Item, Error = Self::Error>,
fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where
A: Future,
B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where
Si2: Sink<Item, Error = Self::Error>,
A: Future,
B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;
Wrap this sink in an Either sink, making it the left-hand variant
of that Either. Read more
sourcefn right_sink<Si1>(self) -> Either<Si1, Self>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where
A: Future,
B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where
Si1: Sink<Item, Error = Self::Error>,
fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where
A: Future,
B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where
Si1: Sink<Item, Error = Self::Error>,
A: Future,
B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;
Wrap this stream in an Either stream, making it the right-hand variant
of that Either. Read more
sourcefn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
A convenience method for calling Sink::poll_ready on Unpin
sink types. Read more
sourcefn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
A convenience method for calling Sink::start_send on Unpin
sink types. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more