pub struct Sender<T>(/* private fields */);
Expand description
The transmission end of a bounded mpsc channel.
This value is created by the channel
function.
Implementations§
Source§impl<T> Sender<T>
impl<T> Sender<T>
Sourcepub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<T>>
pub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<T>>
Attempts to send a message on this Sender
, returning the message
if there was an error.
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 function should only be called after
poll_ready
has reported that the channel is
ready to receive a message.
Sourcepub fn poll_ready(
&mut self,
cx: &mut Context<'_>,
) -> Poll<Result<(), SendError>>
pub fn poll_ready( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), SendError>>
Polls the channel to determine if there is guaranteed capacity to send at least one item without waiting.
§Return value
This method returns:
Poll::Ready(Ok(_))
if there is sufficient capacity;Poll::Pending
if the channel may not have capacity, in which case the current task is queued to be notified once capacity is available;Poll::Ready(Err(SendError))
if the receiver has been dropped.
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(&mut self)
pub fn close_channel(&mut 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 same_receiver(&self, other: &Sender<T>) -> bool
pub fn same_receiver(&self, other: &Sender<T>) -> bool
Returns whether the senders send to the same receiver.
Sourcepub fn is_connected_to(&self, receiver: &Receiver<T>) -> bool
pub fn is_connected_to(&self, receiver: &Receiver<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§
Source§impl<T> Sink<T> for Sender<T>
impl<T> Sink<T> for Sender<T>
Source§fn poll_ready(
self: Pin<&mut Sender<T>>,
cx: &mut Context<'_>,
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>
fn poll_ready( self: Pin<&mut Sender<T>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>
Sink
to receive a value. Read moreSource§fn start_send(
self: Pin<&mut Sender<T>>,
msg: T,
) -> Result<(), <Sender<T> as Sink<T>>::Error>
fn start_send( self: Pin<&mut Sender<T>>, msg: T, ) -> Result<(), <Sender<T> as Sink<T>>::Error>
poll_ready
which returned Poll::Ready(Ok(()))
. Read moreAuto Trait Implementations§
impl<T> Freeze for Sender<T>
impl<T> !RefUnwindSafe for Sender<T>
impl<T> Send for Sender<T>where
T: Send,
impl<T> Sync for Sender<T>where
T: Send,
impl<T> Unpin for Sender<T>
impl<T> !UnwindSafe for Sender<T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T, Item> SinkExt<Item> for T
impl<T, Item> SinkExt<Item> for T
Source§fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F>
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F>
Source§fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F>
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F>
Source§fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>
Source§fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>
Into
trait. Read moreSource§fn buffer(self, capacity: usize) -> Buffer<Self, Item>where
Self: Sized,
fn buffer(self, capacity: usize) -> Buffer<Self, Item>where
Self: Sized,
Source§fn flush(&mut self) -> Flush<'_, Self, Item> ⓘwhere
Self: Unpin,
fn flush(&mut self) -> Flush<'_, Self, Item> ⓘwhere
Self: Unpin,
Source§fn send(&mut self, item: Item) -> Send<'_, Self, Item> ⓘwhere
Self: Unpin,
fn send(&mut self, item: Item) -> Send<'_, Self, Item> ⓘwhere
Self: Unpin,
Source§fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> ⓘwhere
Self: Unpin,
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> ⓘwhere
Self: Unpin,
Source§fn send_all<'a, St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> ⓘ
fn send_all<'a, St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> ⓘ
Source§fn right_sink<Si1>(self) -> Either<Si1, Self> ⓘ
fn right_sink<Si1>(self) -> Either<Si1, Self> ⓘ
Source§fn 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,
Sink::poll_ready
on Unpin
sink types.Source§fn 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,
Sink::start_send
on Unpin
sink types.Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 24 bytes