Struct futures::sync::mpsc::UnboundedSender

source · [−]

pub struct UnboundedSender<T>(_);

Expand description

The transmission end of a channel which is used to send values.

This is created by the unbounded method.

Implementations

source

impl<T> UnboundedSender<T>

source

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

source

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

Sends the provided 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>

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> Debug for UnboundedSender<T>

source

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

Formats the value using the given formatter. Read more

source

impl<T> Sink for UnboundedSender<T>

type SinkItem = T

The type of value that the sink accepts.

type SinkError = SendError<T>

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

source

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

Begin the process of sending a value to the sink. Read more

source

fn poll_complete(&mut self) -> Poll<(), SendError<T>>

Flush all output from this sink, if necessary. Read more

source

fn close(&mut self) -> Poll<(), SendError<T>>

A method to indicate that no more values will ever be pushed into this sink. Read more

source

fn wait(self) -> Wait<Self> where
Self: Sized,

Creates a new object which will produce a synchronous sink. Read more

source

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

Composes a function in front of the sink. Read more

source

fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St> 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<F, E>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E,
Self: Sized,

Transforms the error returned by the sink.

source

fn sink_from_err<E: From<Self::SinkError>>(self) -> SinkFromErr<Self, E> where
Self: Sized,

Map this sink’s error to any error implementing From for this sink’s Error, returning a new sink. 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 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,

A future that completes when the sink has finished processing all pending requests. 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::Error>,
 Self: Sized,

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

source

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

type SinkItem = T

The type of value that the sink accepts.

type SinkError = SendError<T>

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

source

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

Begin the process of sending a value to the sink. Read more

source

fn poll_complete(&mut self) -> Poll<(), SendError<T>>

Flush all output from this sink, if necessary. Read more

source

fn close(&mut self) -> Poll<(), SendError<T>>

A method to indicate that no more values will ever be pushed into this sink. Read more

source

fn wait(self) -> Wait<Self> where
Self: Sized,

Creates a new object which will produce a synchronous sink. Read more

source

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

Composes a function in front of the sink. Read more

source

fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St> 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<F, E>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E,
Self: Sized,

Transforms the error returned by the sink.

source

fn sink_from_err<E: From<Self::SinkError>>(self) -> SinkFromErr<Self, E> where
Self: Sized,

Map this sink’s error to any error implementing From for this sink’s Error, returning a new sink. 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 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,

A future that completes when the sink has finished processing all pending requests. 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::Error>,
 Self: Sized,

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

Auto Trait Implementations

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

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

Returns the argument unchanged.

source

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

const: unstable · source

pub 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

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::sync::mpsc::UnboundedSender

Implementations

impl<T> UnboundedSender<T>

pub fn is_closed(&self) -> bool

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

Trait Implementations

impl<T> Clone for UnboundedSender<T>

fn clone(&self) -> UnboundedSender<T>

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

impl<T: Debug> Debug for UnboundedSender<T>

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

impl<T> Sink for UnboundedSender<T>

type SinkItem = T

type SinkError = SendError<T>

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

fn poll_complete(&mut self) -> Poll<(), SendError<T>>

fn close(&mut self) -> Poll<(), SendError<T>>

fn wait(self) -> Wait<Self> where Self: Sized,

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

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

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

fn sink_from_err<E: From<Self::SinkError>>(self) -> SinkFromErr<Self, E> where Self: Sized,

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

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

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

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

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

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

type SinkItem = T

type SinkError = SendError<T>

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

fn poll_complete(&mut self) -> Poll<(), SendError<T>>

fn close(&mut self) -> Poll<(), SendError<T>>

fn wait(self) -> Wait<Self> where Self: Sized,

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

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

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

fn sink_from_err<E: From<Self::SinkError>>(self) -> SinkFromErr<Self, E> where Self: Sized,

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

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

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

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

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

Auto Trait Implementations

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

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

fn wait(self) -> Wait<Self> where
Self: Sized,

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

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

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

fn sink_from_err<E: From<Self::SinkError>>(self) -> SinkFromErr<Self, E> where
Self: Sized,

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

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

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

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

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

fn wait(self) -> Wait<Self> where
Self: Sized,

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

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

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

fn sink_from_err<E: From<Self::SinkError>>(self) -> SinkFromErr<Self, E> where
Self: Sized,

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

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

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

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

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

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

impl<T> Sync for UnboundedSender<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> 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>,