[−][src]Struct futures_channel::mpsc::UnboundedSender
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.
pub fn same_receiver(&self, other: &Self) -> bool[src]
Returns whether the senders send to the same receiver.
Trait Implementations
impl<T> Clone for UnboundedSender<T>[src]
fn clone(&self) -> UnboundedSender<T>[src]
fn clone_from(&mut self, source: &Self)1.0.0[src]
impl<T: Debug> Debug 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]
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> Send for UnboundedSender<T> where
T: Send,
T: Send,
impl<T> Unpin for UnboundedSender<T>
impl<T> Sync for UnboundedSender<T> where
T: Send,
T: Send,
impl<T> !UnwindSafe for UnboundedSender<T>
impl<T> !RefUnwindSafe for UnboundedSender<T>
Blanket Implementations
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]
fn clone_into(&self, target: &mut T)[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> From<T> for T[src]
impl<T, U> TryFrom<U> 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, U> TryInto<U> 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> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,