Struct tokio_util::sync::PollSender
source · pub struct PollSender<T> { /* private fields */ }
Expand description
A wrapper around mpsc::Sender
that can be polled.
Implementations§
source§impl<T: Send> PollSender<T>
impl<T: Send> PollSender<T>
sourcepub fn poll_reserve(
&mut self,
cx: &mut Context<'_>,
) -> Poll<Result<(), PollSendError<T>>>
pub fn poll_reserve( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), PollSendError<T>>>
Attempts to prepare the sender to receive a value.
This method must be called and return Poll::Ready(Ok(()))
prior to each call to
send_item
.
This method returns Poll::Ready
once the underlying channel is ready to receive a value,
by reserving a slot in the channel for the item to be sent. If this method returns
Poll::Pending
, the current task is registered to be notified (via
cx.waker().wake_by_ref()
) when poll_reserve
should be called again.
§Errors
If the channel is closed, an error will be returned. This is a permanent state.
sourcepub fn send_item(&mut self, value: T) -> Result<(), PollSendError<T>>
pub fn send_item(&mut self, value: T) -> Result<(), PollSendError<T>>
Sends an item to the channel.
Before calling send_item
, poll_reserve
must be called with a successful return
value of Poll::Ready(Ok(()))
.
§Errors
If the channel is closed, an error will be returned. This is a permanent state.
§Panics
If poll_reserve
was not successfully called prior to calling send_item
, then this method
will panic.
sourcepub fn is_closed(&self) -> bool
pub fn is_closed(&self) -> bool
Checks whether this sender is been closed.
The underlying channel that this sender was wrapping may still be open.
sourcepub fn get_ref(&self) -> Option<&Sender<T>>
pub fn get_ref(&self) -> Option<&Sender<T>>
Gets a reference to the Sender
of the underlying channel.
If PollSender
has been closed, None
is returned. The underlying channel that this sender
was wrapping may still be open.
sourcepub fn close(&mut self)
pub fn close(&mut self)
Closes this sender.
No more messages will be able to be sent from this sender, but the underlying channel will
remain open until all senders have dropped, or until the Receiver
closes the channel.
If a slot was previously reserved by calling poll_reserve
, then a final call can be made
to send_item
in order to consume the reserved slot. After that, no further sends will be
possible. If you do not intend to send another item, you can release the reserved slot back
to the underlying sender by calling abort_send
.
sourcepub fn abort_send(&mut self) -> bool
pub fn abort_send(&mut self) -> bool
Aborts the current in-progress send, if any.
Returns true
if a send was aborted. If the sender was closed prior to calling
abort_send
, then the sender will remain in the closed state, otherwise the sender will be
ready to attempt another send.
Trait Implementations§
source§impl<T> Clone for PollSender<T>
impl<T> Clone for PollSender<T>
source§fn clone(&self) -> PollSender<T>
fn clone(&self) -> PollSender<T>
Clones this PollSender
.
The resulting PollSender
will have an initial state identical to calling PollSender::new
.
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<T: Debug> Debug for PollSender<T>
impl<T: Debug> Debug for PollSender<T>
source§impl<T: Send> Sink<T> for PollSender<T>
impl<T: Send> Sink<T> for PollSender<T>
source§type Error = PollSendError<T>
type Error = PollSendError<T>
source§fn 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>>
Sink
to receive a value. Read moresource§fn poll_flush(
self: Pin<&mut Self>,
_cx: &mut Context<'_>,
) -> Poll<Result<(), Self::Error>>
fn poll_flush( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>
Auto Trait Implementations§
impl<T> Freeze for PollSender<T>
impl<T> !RefUnwindSafe for PollSender<T>
impl<T> Send for PollSender<T>where
T: Send,
impl<T> Sync for PollSender<T>where
T: Send,
impl<T> Unpin for PollSender<T>
impl<T> !UnwindSafe for PollSender<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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)