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<'_>,
) -> Result<Async<()>, SendError>
pub fn poll_ready( &mut self, cx: &mut Context<'_>, ) -> Result<Async<()>, SendError>
Polls the channel to determine if there is guaranteed capacity to send at least one item without waiting.
§Return value
This method returns:
Ok(Async::Ready(_))
if there is sufficient capacity;Ok(Async::Pending)
if the channel may not have capacity, in which case the current task is queued to be notified once capacity is available;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.
Trait Implementations§
Source§impl<T> Sink for Sender<T>
impl<T> Sink for Sender<T>
Source§fn poll_ready(
&mut self,
cx: &mut Context<'_>,
) -> Result<Async<()>, <Sender<T> as Sink>::SinkError>
fn poll_ready( &mut self, cx: &mut Context<'_>, ) -> Result<Async<()>, <Sender<T> as Sink>::SinkError>
Attempts to prepare the
Sink
to receive a value. Read moreSource§fn start_send(&mut self, msg: T) -> Result<(), <Sender<T> as Sink>::SinkError>
fn start_send(&mut self, msg: T) -> Result<(), <Sender<T> as Sink>::SinkError>
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 Ok(Async::Ready(()))
. 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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> SinkExt for T
impl<T> SinkExt for T
Source§fn with<U, Fut, F>(self, f: F) -> With<Self, U, Fut, F>where
F: FnMut(U) -> Fut,
Fut: IntoFuture<Item = Self::SinkItem>,
<Fut as IntoFuture>::Error: From<Self::SinkError>,
Self: Sized,
fn with<U, Fut, F>(self, f: F) -> With<Self, U, Fut, F>where
F: FnMut(U) -> Fut,
Fut: IntoFuture<Item = Self::SinkItem>,
<Fut as IntoFuture>::Error: From<Self::SinkError>,
Self: Sized,
Composes a function in front of the sink. Read more
Source§fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, U, St, F>
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, U, St, F>
Composes a function in front of the sink. Read more
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>
Transforms the error returned by the sink.
Source§fn sink_err_into<E>(self) -> SinkErrInto<Self, E>
fn sink_err_into<E>(self) -> SinkErrInto<Self, E>
Map this sink’s error to a different error type using the
Into
trait. Read moreSource§fn buffer(self, amt: usize) -> Buffer<Self>where
Self: Sized,
fn buffer(self, amt: usize) -> Buffer<Self>where
Self: Sized,
Adds a fixed-size buffer to the current sink. Read more
Source§fn flush(self) -> Flush<Self>where
Self: Sized,
fn flush(self) -> Flush<Self>where
Self: Sized,
Flush the sync, processing all pending items. Read more
Source§fn send(self, item: Self::SinkItem) -> Send<Self>where
Self: Sized,
fn send(self, item: Self::SinkItem) -> Send<Self>where
Self: Sized,
A future that completes after the given item has been fully processed
into the sink, including flushing. Read more
Source§fn send_all<S>(self, stream: S) -> SendAll<Self, S>
fn send_all<S>(self, stream: S) -> SendAll<Self, S>
A future that completes after the given stream has been fully processed
into the sink, including flushing. Read more