Struct futures::channel::mpsc::UnboundedSender [−][src]
pub struct UnboundedSender<T>(_);
The transmission end of an unbounded mpsc channel.
This value is created by the unbounded function.
Methods
impl<T> UnboundedSender<T>[src]
impl<T> UnboundedSender<T>pub fn poll_ready(&self, &mut Context) -> Poll<Result<(), SendError>>[src]
pub fn poll_ready(&self, &mut Context) -> Poll<Result<(), SendError>>Check if the channel is ready to receive a message.
pub fn is_closed(&self) -> bool[src]
pub fn is_closed(&self) -> boolReturns whether this channel is closed without needing a context.
pub fn close_channel(&self)[src]
pub fn close_channel(&self)Closes this channel from the sender side, preventing any new messages.
pub fn start_send(&mut self, msg: T) -> Result<(), SendError>[src]
pub fn start_send(&mut self, msg: T) -> Result<(), SendError>Send a message on the channel.
This method should only be called after poll_ready has been used to
verify that the channel is ready to receive a message.
pub fn unbounded_send(&self, msg: T) -> Result<(), TrySendError<T>>[src]
pub fn unbounded_send(&self, msg: T) -> Result<(), TrySendError<T>>Sends a message along this channel.
This is an unbounded sender, so this function differs from Sink::send
by ensuring the return type reflects that the channel is always ready to
receive messages.
Trait Implementations
impl<'a, T> Sink for &'a UnboundedSender<T>[src]
impl<'a, T> Sink for &'a UnboundedSender<T>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 poll_ready(
self: PinMut<&'a UnboundedSender<T>>,
cx: &mut Context
) -> Poll<Result<(), <&'a UnboundedSender<T> as Sink>::SinkError>>[src]
fn poll_ready(
self: PinMut<&'a UnboundedSender<T>>,
cx: &mut Context
) -> Poll<Result<(), <&'a UnboundedSender<T> as Sink>::SinkError>>Attempts to prepare the Sink to receive a value. Read more
fn start_send(
self: PinMut<&'a UnboundedSender<T>>,
msg: T
) -> Result<(), <&'a UnboundedSender<T> as Sink>::SinkError>[src]
fn start_send(
self: PinMut<&'a UnboundedSender<T>>,
msg: T
) -> Result<(), <&'a UnboundedSender<T> as Sink>::SinkError>Begin the process of sending a value to the sink. Each call to this function must be proceeded by a successful call to poll_ready which returned Ok(Poll::Ready(())). Read more
fn poll_flush(
self: PinMut<&'a UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <&'a UnboundedSender<T> as Sink>::SinkError>>[src]
fn poll_flush(
self: PinMut<&'a UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <&'a UnboundedSender<T> as Sink>::SinkError>>Flush any remaining output from this sink. Read more
fn poll_close(
self: PinMut<&'a UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <&'a UnboundedSender<T> as Sink>::SinkError>>[src]
fn poll_close(
self: PinMut<&'a UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <&'a UnboundedSender<T> as Sink>::SinkError>>Flush any remaining output and close this sink, if necessary. Read more
impl<T> Sink for UnboundedSender<T>[src]
impl<T> Sink for UnboundedSender<T>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 poll_ready(
self: PinMut<UnboundedSender<T>>,
cx: &mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink>::SinkError>>[src]
fn poll_ready(
self: PinMut<UnboundedSender<T>>,
cx: &mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink>::SinkError>>Attempts to prepare the Sink to receive a value. Read more
fn start_send(
self: PinMut<UnboundedSender<T>>,
msg: T
) -> Result<(), <UnboundedSender<T> as Sink>::SinkError>[src]
fn start_send(
self: PinMut<UnboundedSender<T>>,
msg: T
) -> Result<(), <UnboundedSender<T> as Sink>::SinkError>Begin the process of sending a value to the sink. Each call to this function must be proceeded by a successful call to poll_ready which returned Ok(Poll::Ready(())). Read more
fn poll_flush(
self: PinMut<UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink>::SinkError>>[src]
fn poll_flush(
self: PinMut<UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink>::SinkError>>Flush any remaining output from this sink. Read more
fn poll_close(
self: PinMut<UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink>::SinkError>>[src]
fn poll_close(
self: PinMut<UnboundedSender<T>>,
&mut Context
) -> Poll<Result<(), <UnboundedSender<T> as Sink>::SinkError>>Flush any remaining output and close this sink, if necessary. Read more
impl<T> Clone for UnboundedSender<T>[src]
impl<T> Clone for UnboundedSender<T>fn clone(&self) -> UnboundedSender<T>[src]
fn clone(&self) -> UnboundedSender<T>Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl<T> Debug for UnboundedSender<T> where
T: Debug, [src]
impl<T> Debug for UnboundedSender<T> where
T: Debug, Auto Trait Implementations
impl<T> Send for UnboundedSender<T> where
T: Send,
impl<T> Send for UnboundedSender<T> where
T: Send, impl<T> Sync for UnboundedSender<T> where
T: Send,
impl<T> Sync for UnboundedSender<T> where
T: Send, Blanket Implementations
impl<T> From for T[src]
impl<T> From for Timpl<T, U> TryFrom for T where
T: From<U>, [src]
impl<T, U> TryFrom for T where
T: From<U>, type Error = !
try_from)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>try_from)Performs the conversion.
impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
impl<T, U> TryInto for T where
U: TryFrom<T>, type Error = <U as TryFrom<T>>::Error
try_from)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>try_from)Performs the conversion.
impl<T, U> Into for T where
U: From<T>, [src]
impl<T, U> Into for T where
U: From<T>, impl<T> Borrow for T where
T: ?Sized, [src]
impl<T> Borrow for T where
T: ?Sized, ⓘImportant traits for &'a mut Ifn borrow(&self) -> &T[src]
fn borrow(&self) -> &TImmutably borrows from an owned value. Read more
impl<T> BorrowMut for T where
T: ?Sized, [src]
impl<T> BorrowMut for T where
T: ?Sized, ⓘImportant traits for &'a mut Ifn borrow_mut(&mut self) -> &mut T[src]
fn borrow_mut(&mut self) -> &mut TMutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized, [src]
impl<T> Any for T where
T: 'static + ?Sized, fn get_type_id(&self) -> TypeId[src]
fn get_type_id(&self) -> TypeId🔬 This is a nightly-only experimental API. (get_type_id)
this method will likely be replaced by an associated static
Gets the TypeId of self. Read more
impl<T> ToOwned for T where
T: Clone, [src]
impl<T> ToOwned for T where
T: Clone, type Owned = T
fn to_owned(&self) -> T[src]
fn to_owned(&self) -> TCreates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)[src]
fn clone_into(&self, target: &mut T)🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> SinkExt for T where
T: Sink + ?Sized, [src]
impl<T> SinkExt for T where
T: Sink + ?Sized, fn with<U, Fut, F, E>(self, f: F) -> With<Self, U, Fut, F> where
E: From<Self::SinkError>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Self::SinkItem, E>>, [src]
fn with<U, Fut, F, E>(self, f: F) -> With<Self, U, Fut, F> where
E: From<Self::SinkError>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Self::SinkItem, E>>, Composes a function in front of the sink. Read more
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Self::SinkItem, Self::SinkError>>, [src]
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Self::SinkItem, Self::SinkError>>, Composes a function in front of the sink. Read more
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E, [src]
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E, Transforms the error returned by the sink.
fn sink_err_into<E>(self) -> SinkErrInto<Self, E> where
Self::SinkError: Into<E>, [src]
fn sink_err_into<E>(self) -> SinkErrInto<Self, E> where
Self::SinkError: Into<E>, Map this sink's error to a different error type using the Into trait. Read more
fn buffer(self, capacity: usize) -> Buffer<Self>[src]
fn buffer(self, capacity: usize) -> Buffer<Self>Adds a fixed-size buffer to the current sink. Read more
fn close(&mut self) -> Close<Self> where
Self: Unpin, [src]
fn close(&mut self) -> Close<Self> where
Self: Unpin, Close the sink.
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Si: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self::SinkItem: Clone, [src]
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Si: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
Self::SinkItem: Clone, Fanout items to multiple sinks. Read more
fn flush(&mut self) -> Flush<Self> where
Self: Unpin, [src]
fn flush(&mut self) -> Flush<Self> where
Self: Unpin, Flush the sync, processing all pending items. Read more
fn send(&mut self, item: Self::SinkItem) -> Send<Self> where
Self: Unpin, [src]
fn send(&mut self, item: Self::SinkItem) -> Send<Self> where
Self: Unpin, A future that completes after the given item has been fully processed into the sink, including flushing. Read more
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
Self: Unpin,
St: Stream<Item = Self::SinkItem> + Unpin, [src]
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
Self: Unpin,
St: Stream<Item = Self::SinkItem> + Unpin, A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
ⓘImportant traits for Either<L, R>fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, [src]
fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more
ⓘImportant traits for Either<L, R>fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, [src]
fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more