[−][src]Struct tokio::sync::mpsc::Sender
Send values to the associated Receiver
.
Instances are created by the channel
function.
Methods
impl<T> Sender<T>
[src]
pub fn poll_ready(&mut self) -> Result<Async<()>, SendError>
[src]
Check if the Sender
is ready to handle a value.
Polls the channel to determine if there is guaranteed capacity to send at least one item without waiting.
When poll_ready
returns Ready
, the channel reserves capacity for one
message for this Sender
instance. The capacity is held until a message
is send or the Sender
instance is dropped. Callers should ensure a
message is sent in a timely fashion in order to not starve other
Sender
instances.
Return value
This method returns:
Ok(Async::Ready(_))
if capacity is reserved for a single message.Ok(Async::NotReady)
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.
pub fn try_send(&mut self, message: T) -> Result<(), TrySendError<T>>
[src]
Attempts to send a message on this Sender
, returning the message
if there was an error.
Trait Implementations
impl<T> Debug for Sender<T>
[src]
impl<T> Clone for Sender<T>
[src]
fn clone(&self) -> Sender<T>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<T> Sink for Sender<T>
[src]
type SinkItem = T
The type of value that the sink accepts.
type SinkError = SendError
The type of value produced by the sink when an error occurs.
fn start_send(
&mut self,
msg: T
) -> Result<AsyncSink<T>, <Sender<T> as Sink>::SinkError>
[src]
&mut self,
msg: T
) -> Result<AsyncSink<T>, <Sender<T> as Sink>::SinkError>
fn poll_complete(&mut self) -> Result<Async<()>, <Sender<T> as Sink>::SinkError>
[src]
fn close(&mut self) -> Result<Async<()>, <Sender<T> as Sink>::SinkError>
[src]
fn wait(self) -> Wait<Self>
[src]
Creates a new object which will produce a synchronous sink. Read more
fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut> where
F: FnMut(U) -> Fut,
Fut: IntoFuture<Item = Self::SinkItem>,
<Fut as IntoFuture>::Error: From<Self::SinkError>,
[src]
F: FnMut(U) -> Fut,
Fut: IntoFuture<Item = Self::SinkItem>,
<Fut as IntoFuture>::Error: From<Self::SinkError>,
Composes a function in front of the sink. Read more
fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St> where
F: FnMut(U) -> St,
St: Stream<Item = Self::SinkItem, Error = Self::SinkError>,
[src]
F: FnMut(U) -> St,
St: Stream<Item = Self::SinkItem, Error = Self::SinkError>,
Composes a function in front of the sink. Read more
fn sink_map_err<F, E>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E,
[src]
F: FnOnce(Self::SinkError) -> E,
Transforms the error returned by the sink.
fn sink_from_err<E>(self) -> SinkFromErr<Self, E> where
E: From<Self::SinkError>,
[src]
E: From<Self::SinkError>,
Map this sink's error to any error implementing From
for this sink's Error
, returning a new sink. Read more
fn buffer(self, amt: usize) -> Buffer<Self>
[src]
Adds a fixed-size buffer to the current sink. Read more
fn fanout<S>(self, other: S) -> Fanout<Self, S> where
S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self::SinkItem: Clone,
[src]
S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self::SinkItem: Clone,
Fanout items to multiple sinks. Read more
fn flush(self) -> Flush<Self>
[src]
A future that completes when the sink has finished processing all pending requests. Read more
fn send(self, item: Self::SinkItem) -> Send<Self>
[src]
A future that completes after the given item has been fully processed into the sink, including flushing. Read more
fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
S: Stream<Item = Self::SinkItem>,
Self::SinkError: From<<S as Stream>::Error>,
[src]
S: Stream<Item = Self::SinkItem>,
Self::SinkError: From<<S as Stream>::Error>,
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
impl<T> From for T
[src]
impl<T, U> TryFrom 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> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Rfn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto 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> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,