Struct futures::channel::mpsc::Sender

source · [−]

pub struct Sender<T>(_);

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: &Sender<T>) -> 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

pub fn clone(&self) -> Sender<T>

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> where
T: Debug,

source

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

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

pub fn poll_ready(
self: Pin<&mut Sender<T>>,
cx: &mut Context<'_>
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

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

source

pub fn start_send(
self: Pin<&mut Sender<T>>,
msg: T
) -> Result<(), <Sender<T> as Sink<T>>::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

pub fn poll_flush(
self: Pin<&mut Sender<T>>,
cx: &mut Context<'_>
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

Flush any remaining output from this sink. Read more

source

pub fn poll_close(
self: Pin<&mut Sender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

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

Auto Trait Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,

source

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
 F: FnMut(U) -> Fut,
 Fut: Future<Output = Result<Item, E>>,
 E: From<Self::Error>,

Composes a function in front of the sink. Read more

source

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>>,

Composes a function in front of the sink. Read more

source

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,

Transforms the error returned by the sink.

source

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,

Map this sink’s error to a different error type using the Into trait. Read more

source

fn buffer(self, capacity: usize) -> Buffer<Self, Item>

Adds a fixed-size buffer to the current sink. Read more

source

fn close(&mut self) -> Close<'_, Self, Item>ⓘ
Notable traits for Close<'_, Si, Item>
`impl<'_, Si, Item> Future for Close<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;`
where
Self: Unpin,

Close the sink.

source

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,

Fanout items to multiple sinks. Read more

source

fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ
Notable traits for Flush<'_, Si, Item>
`impl<'_, Si, Item> Future for Flush<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;`
where
Self: Unpin,

Flush the sink, processing all pending items. Read more

source

fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ
Notable traits for Send<'_, Si, Item>
`impl<'_, Si, Item> Future for Send<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;`
where
Self: Unpin,

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

source

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ
Notable traits for Feed<'_, Si, Item>
`impl<'_, Si, Item> Future for Feed<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;`
where
Self: Unpin,

A future that completes after the given item has been received by the sink. Read more

source

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>ⓘ
Notable traits for SendAll<'_, Si, St>
`impl<'_, Si, St, Ok, Error> Future for SendAll<'_, Si, St> where Si: Sink<Ok, Error = Error> + Unpin + ?Sized, St: Stream<Item = Result<Ok, Error>> + Unpin + ?Sized, type Output = Result<(), Error>;`
where
 St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
 Self: Unpin,

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

source

fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ
Notable traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`
where
Si2: Sink<Item, Error = Self::Error>,

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

source

fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ
Notable traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`
where
Si1: Sink<Item, Error = Self::Error>,

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

source

fn poll_ready_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

A convenience method for calling Sink::poll_ready on Unpin sink types. Read more

source

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,

A convenience method for calling Sink::start_send on Unpin sink types. Read more

source

fn poll_flush_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

A convenience method for calling Sink::poll_flush on Unpin sink types. Read more

source

fn poll_close_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

A convenience method for calling Sink::poll_close on Unpin sink types. Read more

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct futures::channel::mpsc::Sender

Implementations

impl<T> Sender<T>

pub fn try_send(&mut self, msg: T) -> Result<(), TrySendError<T>>

pub fn start_send(&mut self, msg: T) -> Result<(), SendError>

pub fn poll_ready( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), SendError>>

Return value

pub fn is_closed(&self) -> bool

pub fn close_channel(&mut self)

pub fn disconnect(&mut self)

pub fn same_receiver(&self, other: &Sender<T>) -> bool

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

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

Trait Implementations

impl<T> Clone for Sender<T>

pub fn clone(&self) -> Sender<T>

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

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

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

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

type Error = SendError

pub fn poll_ready( self: Pin<&mut Sender<T>>, cx: &mut Context<'_>) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

pub fn start_send( self: Pin<&mut Sender<T>>, msg: T) -> Result<(), <Sender<T> as Sink<T>>::Error>

pub fn poll_flush( self: Pin<&mut Sender<T>>, cx: &mut Context<'_>) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

pub fn poll_close( self: Pin<&mut Sender<T>>, &mut Context<'_>) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

Auto Trait Implementations

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

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T, Item> SinkExt<Item> for T where T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where F: FnMut(U) -> Fut, Fut: Future<Output = Result<Item, E>>, E: From<Self::Error>,

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>>,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::Error) -> E,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self::Error: Into<E>,

fn buffer(self, capacity: usize) -> Buffer<Self, Item>

fn close(&mut self) -> Close<'_, Self, Item>ⓘNotable traits for Close<'_, Si, Item>impl<'_, Si, Item> Future for Close<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Item: Clone, Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item>ⓘNotable traits for Flush<'_, Si, Item>impl<'_, Si, Item> Future for Flush<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘNotable traits for Send<'_, Si, Item>impl<'_, Si, Item> Future for Send<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘNotable traits for Feed<'_, Si, Item>impl<'_, Si, Item> Future for Feed<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>; where Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where Si2: Sink<Item, Error = Self::Error>,

fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output; where Si1: Sink<Item, Error = Self::Error>,

fn poll_ready_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where Self: Unpin,

fn poll_flush_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

fn poll_close_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

pub fn poll_ready(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), SendError>>

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

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

pub fn poll_ready(
self: Pin<&mut Sender<T>>,
cx: &mut Context<'_>
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

pub fn start_send(
self: Pin<&mut Sender<T>>,
msg: T
) -> Result<(), <Sender<T> as Sink<T>>::Error>

pub fn poll_flush(
self: Pin<&mut Sender<T>>,
cx: &mut Context<'_>
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

pub fn poll_close(
self: Pin<&mut Sender<T>>,
&mut Context<'_>
) -> Poll<Result<(), <Sender<T> as Sink<T>>::Error>>

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

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

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

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

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

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

impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,

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>>,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,

fn close(&mut self) -> Close<'_, Self, Item>ⓘ
Notable traits for Close<'_, Si, Item>
`impl<'_, Si, Item> Future for Close<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;`
where
Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ
Notable traits for Flush<'_, Si, Item>
`impl<'_, Si, Item> Future for Flush<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;`
where
Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ
Notable traits for Send<'_, Si, Item>
`impl<'_, Si, Item> Future for Send<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;`
where
Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ
Notable traits for Feed<'_, Si, Item>
`impl<'_, Si, Item> Future for Feed<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, type Output = Result<(), <Si as Sink<Item>>::Error>;`
where
Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ
Notable traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`
where
Si2: Sink<Item, Error = Self::Error>,

fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ
Notable traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`
where
Si1: Sink<Item, Error = Self::Error>,

fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,

fn poll_flush_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

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

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

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