[−][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]
impl<T> Sender<T>pub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<T>>[src]
pub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<T>>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]
pub fn start_send(&mut self, msg: T) -> Result<(), SendError>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, lw: &LocalWaker) -> Poll<Result<(), SendError>>[src]
pub fn poll_ready(&mut self, lw: &LocalWaker) -> Poll<Result<(), SendError>>Polls the channel to determine if there is guaranteed capacity to send at least one item without waiting.
Return value
This method returns:
Ok(Async::Ready(_))if there is sufficient capacity;Ok(Async::Pending)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 is_closed(&self) -> bool[src]
pub fn is_closed(&self) -> boolReturns whether this channel is closed without needing a context.
pub fn close_channel(&mut self)[src]
pub fn close_channel(&mut self)Closes this channel from the sender side, preventing any new messages.
Trait Implementations
impl<T> Clone for Sender<T>[src]
impl<T> Clone for Sender<T>fn clone(&self) -> Sender<T>[src]
fn clone(&self) -> Sender<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> Drop for Sender<T>[src]
impl<T> Drop for Sender<T>impl<T: Debug> Debug for Sender<T>[src]
impl<T: Debug> Debug for Sender<T>fn fmt(&self, f: &mut Formatter) -> Result[src]
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl<T> Unpin for Sender<T>[src]
impl<T> Unpin for Sender<T>Auto Trait Implementations
Blanket Implementations
impl<T, U> Into for T where
U: From<T>, [src]
impl<T, U> Into for T where
U: From<T>, 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> 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> Borrow for T where
T: ?Sized, [src]
impl<T> Borrow for T where
T: ?Sized, 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> BorrowMut for T where
T: ?Sized, [src]
impl<T> BorrowMut for T where
T: ?Sized, fn borrow_mut(&mut self) -> &mut T[src]
fn borrow_mut(&mut self) -> &mut TMutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
impl<T, U> TryInto for T where
U: TryFrom<T>,