Struct futures_channel::mpsc::UnboundedSender [−][src]
pub struct UnboundedSender<T>(_);
The transmission end of an unbounded mpsc channel.
This value is created by the unbounded function.
Implementations
impl<T> UnboundedSender<T>[src]
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.
pub fn same_receiver(&self, other: &Self) -> bool[src]
Returns whether the senders send to the same receiver.
pub fn is_connected_to(&self, receiver: &UnboundedReceiver<T>) -> bool[src]
Returns whether the sender send to this receiver.
pub fn hash_receiver<H>(&self, hasher: &mut H) where
H: Hasher, [src]
H: Hasher,
Hashes the receiver into the provided hasher
Trait Implementations
impl<T> Clone for UnboundedSender<T>[src]
impl<T> Clone for UnboundedSender<T>[src]fn clone(&self) -> Self[src]
pub fn clone_from(&mut self, source: &Self)1.0.0[src]
impl<T> Sink<T> for UnboundedSender<T>[src]
impl<T> Sink<T> for UnboundedSender<T>[src]type Error = SendError
The type of value produced by the sink when an error occurs.
fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
fn start_send(self: Pin<&mut Self>, msg: T) -> Result<(), Self::Error>[src]
fn poll_flush(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
fn poll_close(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
impl<T> Sink<T> for &UnboundedSender<T>[src]
impl<T> Sink<T> for &UnboundedSender<T>[src]type Error = SendError
The type of value produced by the sink when an error occurs.
fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
fn start_send(self: Pin<&mut Self>, msg: T) -> Result<(), Self::Error>[src]
fn poll_flush(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
fn poll_close(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
Auto Trait Implementations
impl<T> !RefUnwindSafe for UnboundedSender<T>
impl<T> Send for UnboundedSender<T> where
T: Send,
T: Send,
impl<T> Sync for UnboundedSender<T> where
T: Send,
T: Send,