[−][src]Struct futures::channel::oneshot::Sender
pub struct Sender<T> { /* fields omitted */ }
A means of transmitting a single value to another task.
This is created by the channel
function.
Methods
impl<T> Sender<T>
[src]
impl<T> Sender<T>
pub fn send(self, t: T) -> Result<(), T>
[src]
pub fn send(self, t: T) -> Result<(), T>
Completes this oneshot with a successful result.
This function will consume self
and indicate to the other end, the
Receiver
, that the value provided is the result of the
computation this represents.
If the value is successfully enqueued for the remote end to receive,
then Ok(())
is returned. If the receiving end was dropped before
this function was called, however, then Err
is returned with the value
provided.
pub fn poll_cancel(&mut self, cx: &mut Context) -> Poll<()>
[src]
pub fn poll_cancel(&mut self, cx: &mut Context) -> Poll<()>
Polls this Sender
half to detect whether its associated
Receiver
with has been dropped.
Return values
If Ok(Ready)
is returned then the associated Receiver
has been
dropped, which means any work required for sending should be canceled.
If Ok(Pending)
is returned then the associated Receiver
is still
alive and may be able to receive a message if sent. The current task,
however, is scheduled to receive a notification if the corresponding
Receiver
goes away.
pub fn is_canceled(&self) -> bool
[src]
pub fn is_canceled(&self) -> bool
Tests to see whether this Sender
's corresponding Receiver
has been dropped.
Unlike poll_cancel
, this function does not
enqueue a task for wakeup upon cancellation, but merely reports the
current state, which may be subject to concurrent modification.
Trait Implementations
impl<T> Unpin for Sender<T>
[src]
impl<T> Unpin for Sender<T>
impl<T> Debug for Sender<T> where
T: Debug,
[src]
impl<T> Debug for Sender<T> where
T: Debug,
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<T> Drop for Sender<T>
[src]
impl<T> Drop for Sender<T>
Auto Trait Implementations
Blanket Implementations
impl<T> From for T
[src]
impl<T> From for T
impl<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) -> &T
Immutably 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 T
Mutably 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