[−][src]Struct futures::channel::mpsc::Sender
The transmission end of a bounded mpsc channel.
This value is created by the channel
function.
Methods
impl<T> Sender<T>
[src]
pub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<T>>
[src]
Attempts to send a message on this Sender
, returning the message
if there was an error.
pub fn start_send(&mut self, msg: T) -> Result<(), SendError>
[src]
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.
pub fn poll_ready(&mut self, cx: &mut Context) -> Poll<Result<(), SendError>>
[src]
Polls the channel to determine if there is guaranteed capacity to send at least one item without waiting.
Return value
This method returns:
Poll::Ready(Ok(_))
if there is sufficient capacity;Poll::Pending
if the channel may not have capacity, in which case the current task is queued to be notified once capacity is available;Poll::Ready(Err(SendError))
if the receiver has been dropped.
pub fn is_closed(&self) -> bool
[src]
Returns whether this channel is closed without needing a context.
pub fn close_channel(&mut self)
[src]
Closes this channel from the sender side, preventing any new messages.
pub fn disconnect(&mut self)
[src]
Disconnects this sender from the channel, closing it if there are no more senders left.
pub fn same_receiver(&self, other: &Sender<T>) -> bool
[src]
Returns whether the senders send to the same receiver.
Trait Implementations
impl<T> Sink<T> for Sender<T>
[src]
type Error = SendError
The type of value produced by the sink when an error occurs.
fn poll_ready(
self: Pin<&mut Sender<T>>,
cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>
[src]
self: Pin<&mut Sender<T>>,
cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>
fn start_send(
self: Pin<&mut Sender<T>>,
msg: T
) -> Result<(), <Sender<T> as Sink<T>>::Error>
[src]
self: Pin<&mut Sender<T>>,
msg: T
) -> Result<(), <Sender<T> as Sink<T>>::Error>
fn poll_flush(
self: Pin<&mut Sender<T>>,
cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>
[src]
self: Pin<&mut Sender<T>>,
cx: &mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>
fn poll_close(
self: Pin<&mut Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>
[src]
self: Pin<&mut Sender<T>>,
&mut Context
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>
impl<T> Clone for Sender<T>
[src]
impl<T> Debug for Sender<T> where
T: Debug,
[src]
T: Debug,
Auto Trait Implementations
impl<T> Send for Sender<T> where
T: Send,
T: Send,
impl<T> Sync for Sender<T> where
T: Send,
T: Send,
impl<T> Unpin for Sender<T>
impl<T> !RefUnwindSafe for Sender<T>
impl<T> !UnwindSafe for Sender<T>
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> 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, U> TryInto<U> 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> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]
T: Sink<Item> + ?Sized,
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
[src]
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
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>>,
[src]
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
[src]
F: FnOnce(Self::Error) -> E,
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
[src]
Self::Error: Into<E>,
fn buffer(self, capacity: usize) -> Buffer<Self, Item>
[src]
ⓘImportant traits for Close<'_, Si, Item>fn close(&mut self) -> Close<Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
ⓘImportant traits for Flush<'_, Si, Item>fn flush(&mut self) -> Flush<Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
ⓘImportant traits for Send<'_, Si, Item>fn send(&mut self, item: Item) -> Send<Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
ⓘImportant traits for SendAll<'_, Si, St>fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
Self: Unpin,
St: Stream<Item = Item> + Unpin,
[src]
Self: Unpin,
St: Stream<Item = Item> + Unpin,
ⓘImportant traits for Either<A, B>fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>,
[src]
Si2: Sink<Item, Error = Self::Error>,
ⓘImportant traits for Either<A, B>fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>,
[src]
Si1: Sink<Item, Error = Self::Error>,
fn compat(self) -> CompatSink<Self, Item> where
Self: Unpin,
[src]
Self: Unpin,