Struct tokio_util::sync::PollSender
source · [−]pub struct PollSender<T> { /* private fields */ }
Expand description
A wrapper around mpsc::Sender
that can be polled.
Implementations
sourceimpl<T: Send + 'static> PollSender<T>
impl<T: Send + 'static> 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
sourceimpl<T> Clone for PollSender<T>
impl<T> Clone for PollSender<T>
sourcefn 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 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<T: Debug> Debug for PollSender<T>
impl<T: Debug> Debug for PollSender<T>
sourceimpl<T: Send + 'static> Sink<T> for PollSender<T>
impl<T: Send + 'static> Sink<T> for PollSender<T>
type Error = PollSendError<T>
type Error = PollSendError<T>
The type of value produced by the sink when an error occurs.
sourcefn 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>>
Attempts to prepare the Sink
to receive a value. Read more
sourcefn 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>>
Flush any remaining output from this sink. Read more
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
sourcefn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,
Composes a function in front of the sink. Read more
sourcefn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
Composes a function in front of the sink. Read more
sourcefn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Transforms the error returned by the sink.
sourcefn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
Map this sink’s error to a different error type using the Into
trait. Read more
sourcefn buffer(self, capacity: usize) -> Buffer<Self, Item>
fn buffer(self, capacity: usize) -> Buffer<Self, Item>
Adds a fixed-size buffer to the current sink. Read more
sourcefn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
Fanout items to multiple sinks. Read more
sourcefn flush(&mut self) -> Flush<'_, Self, Item> where
Self: Unpin,
fn flush(&mut self) -> Flush<'_, Self, Item> where
Self: Unpin,
Flush the sink, processing all pending items. Read more
sourcefn send(&mut self, item: Item) -> Send<'_, Self, Item> where
Self: Unpin,
fn send(&mut self, item: Item) -> Send<'_, Self, Item> where
Self: Unpin,
A future that completes after the given item has been fully processed into the sink, including flushing. Read more
sourcefn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where
Self: Unpin,
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where
Self: Unpin,
A future that completes after the given item has been received by the sink. Read more
sourcefn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
sourcefn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>,
fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>,
Wrap this sink in an Either
sink, making it the left-hand variant
of that Either
. Read more
sourcefn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>,
fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>,
Wrap this stream in an Either
stream, making it the right-hand variant
of that Either
. Read more
sourcefn 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,
A convenience method for calling Sink::poll_ready
on Unpin
sink types. Read more
sourcefn 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,
A convenience method for calling Sink::start_send
on Unpin
sink types. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more