Struct futures_channel::mpsc::UnboundedSender
source · [−]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: &Self) -> bool
pub fn same_receiver(&self, other: &Self) -> 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>
sourceimpl<T: Debug> Debug for UnboundedSender<T>
impl<T: Debug> Debug for UnboundedSender<T>
sourceimpl<T> Sink<T> for UnboundedSender<T>
impl<T> Sink<T> for UnboundedSender<T>
sourcefn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
Attempts to prepare the Sink to receive a value. Read more
sourcefn start_send(self: Pin<&mut Self>, msg: T) -> Result<(), Self::Error>
fn start_send(self: Pin<&mut Self>, msg: T) -> Result<(), Self::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
sourceimpl<T> Sink<T> for &UnboundedSender<T>
impl<T> Sink<T> for &UnboundedSender<T>
sourcefn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
Attempts to prepare the Sink to receive a value. Read more
sourcefn start_send(self: Pin<&mut Self>, msg: T) -> Result<(), Self::Error>
fn start_send(self: Pin<&mut Self>, msg: T) -> Result<(), Self::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
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> 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