Struct futures::unsync::mpsc::UnboundedSender

[+] Show declaration

pub struct UnboundedSender<T>(_);

[−] Expand description

The transmission end of an unbounded channel.

This is created by the unbounded function.

Methods

impl<T> UnboundedSender<T>[−]

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

impl<T> Clone for UnboundedSender<T>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T: Debug> Debug for UnboundedSender<T>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<T> Sink for UnboundedSender<T>[+]

[+] Show hidden undocumented items

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.

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

Begin the process of sending a value to the sink.

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

Flush all output from this sink, if necessary.

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

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

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

Creates a new object which will produce a synchronous sink.

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.

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.

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.

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.

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

Adds a fixed-size buffer to the current sink.

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.

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

A future that completes when the sink has finished processing all pending requests.

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.

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.

impl<'a, T> Sink for &'a UnboundedSender<T>[+]

[+] Show hidden undocumented items

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.

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

Begin the process of sending a value to the sink.

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

Flush all output from this sink, if necessary.

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

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

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

Creates a new object which will produce a synchronous sink.

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.

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.

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.

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.

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

Adds a fixed-size buffer to the current sink.

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.

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

A future that completes when the sink has finished processing all pending requests.

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.

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.