Struct futures_channel::mpsc::Sender

source ·
pub struct Sender<T>(/* private fields */);
Expand description

The transmission end of a bounded mpsc channel.

This value is created by the channel function.

Implementations§

source§

impl<T> Sender<T>

source

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.

source

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.

source

pub fn poll_ready( &mut self, cx: &mut Context<'_> ) -> 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:

  • 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.
source

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

source

pub fn close_channel(&mut self)

Closes this channel from the sender side, preventing any new messages.

source

pub fn disconnect(&mut self)

Disconnects this sender from the channel, closing it if there are no more senders left.

source

pub fn same_receiver(&self, other: &Self) -> bool

Returns whether the senders send to the same receiver.

source

pub fn is_connected_to(&self, receiver: &Receiver<T>) -> bool

Returns whether the sender send to this receiver.

source

pub fn hash_receiver<H>(&self, hasher: &mut H)
where H: Hasher,

Hashes the receiver into the provided hasher

Trait Implementations§

source§

impl<T> Clone for Sender<T>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<T> Debug for Sender<T>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T> Sink<T> for Sender<T>

§

type Error = SendError

The type of value produced by the sink when an error occurs.
source§

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value. Read more
source§

fn start_send(self: Pin<&mut Self>, msg: T) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())). Read more
source§

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink. Read more
source§

fn poll_close( self: Pin<&mut Self>, _: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Sender<T>

§

impl<T> !RefUnwindSafe for Sender<T>

§

impl<T> Send for Sender<T>
where T: Send,

§

impl<T> Sync for Sender<T>
where T: Send,

§

impl<T> Unpin for Sender<T>

§

impl<T> !UnwindSafe for Sender<T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.