futures::channel::mpsc

Struct UnboundedSender

Source
pub struct UnboundedSender<T>(/* private fields */);
Expand description

The transmission end of an unbounded mpsc channel.

This value is created by the unbounded function.

Implementations§

Source§

impl<T> UnboundedSender<T>

Source

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

Check if the channel is ready to receive a message.

Source

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

Source

pub fn close_channel(&self)

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

Source

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

Send a message on the channel.

This method should only be called after poll_ready has been used to verify that the channel is ready to receive a message.

Source

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

Sends a message along this channel.

This is an unbounded sender, so this function differs from Sink::send by ensuring the return type reflects that the channel is always ready to receive messages.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> UnboundedSender<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 UnboundedSender<T>
where T: Debug,

Source§

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

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

impl<T> Drop for UnboundedSender<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<'a, T> Sink for &'a UnboundedSender<T>

Source§

type SinkItem = T

The type of value that the sink accepts.
Source§

type SinkError = SendError

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

fn poll_ready( &mut self, cx: &mut Context<'_>, ) -> Result<Async<()>, <&'a UnboundedSender<T> as Sink>::SinkError>

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

fn start_send( &mut self, msg: T, ) -> Result<(), <&'a UnboundedSender<T> as Sink>::SinkError>

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 Ok(Async::Ready(())). Read more
Source§

fn poll_flush( &mut self, _: &mut Context<'_>, ) -> Result<Async<()>, <&'a UnboundedSender<T> as Sink>::SinkError>

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

fn poll_close( &mut self, _: &mut Context<'_>, ) -> Result<Async<()>, <&'a UnboundedSender<T> as Sink>::SinkError>

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

impl<T> Sink for UnboundedSender<T>

Source§

type SinkItem = T

The type of value that the sink accepts.
Source§

type SinkError = SendError

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

fn poll_ready( &mut self, cx: &mut Context<'_>, ) -> Result<Async<()>, <UnboundedSender<T> as Sink>::SinkError>

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

fn start_send( &mut self, msg: T, ) -> Result<(), <UnboundedSender<T> as Sink>::SinkError>

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 Ok(Async::Ready(())). Read more
Source§

fn poll_flush( &mut self, _: &mut Context<'_>, ) -> Result<Async<()>, <UnboundedSender<T> as Sink>::SinkError>

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

fn poll_close( &mut self, _: &mut Context<'_>, ) -> Result<Async<()>, <UnboundedSender<T> as Sink>::SinkError>

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

Auto Trait Implementations§

§

impl<T> Freeze for UnboundedSender<T>

§

impl<T> !RefUnwindSafe for UnboundedSender<T>

§

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

§

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

§

impl<T> Unpin for UnboundedSender<T>

§

impl<T> !UnwindSafe for UnboundedSender<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn with<U, Fut, F>(self, f: F) -> With<Self, U, Fut, F>
where F: FnMut(U) -> Fut, Fut: IntoFuture<Item = Self::SinkItem>, <Fut as IntoFuture>::Error: From<Self::SinkError>, Self: Sized,

Composes a function in front of the sink. Read more
Source§

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, U, St, F>
where F: FnMut(U) -> St, St: Stream<Item = Self::SinkItem, Error = Self::SinkError>, Self: Sized,

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::SinkError) -> E, Self: Sized,

Transforms the error returned by the sink.
Source§

fn sink_err_into<E>(self) -> SinkErrInto<Self, E>
where Self: Sized, Self::SinkError: Into<E>,

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

fn buffer(self, amt: usize) -> Buffer<Self>
where Self: Sized,

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

fn close(self) -> Close<Self>
where Self: Sized,

Close the sink. Read more
Source§

fn fanout<S>(self, other: S) -> Fanout<Self, S>
where Self: Sized, Self::SinkItem: Clone, S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,

Fanout items to multiple sinks. Read more
Source§

fn flush(self) -> Flush<Self>
where Self: Sized,

Flush the sync, processing all pending items. Read more
Source§

fn send(self, item: Self::SinkItem) -> Send<Self>
where Self: Sized,

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

fn send_all<S>(self, stream: S) -> SendAll<Self, S>
where S: Stream<Item = Self::SinkItem>, Self::SinkError: From<<S as Stream>::Error>, Self: Sized,

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

fn left_sink<B>(self) -> Either<Self, B>
where B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, Self: Sized,

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

fn right_sink<B>(self) -> Either<B, Self>
where B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, Self: Sized,

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

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

Source§

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

Source§

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

Source§

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.