Struct futures::sink::Drain [−][src]
#[must_use = "sinks do nothing unless polled"]pub struct Drain<T> { /* fields omitted */ }
Expand description
Sink for the drain
function.
Trait Implementations
impl<T> Sink<T> for Drain<T>
[src]
impl<T> Sink<T> for Drain<T>
[src]type Error = Infallible
type Error = Infallible
The type of value produced by the sink when an error occurs.
pub fn poll_ready(
self: Pin<&mut Drain<T>>,
_cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>
[src]
pub fn poll_ready(
self: Pin<&mut Drain<T>>,
_cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>
[src]Attempts to prepare the Sink
to receive a value. Read more
pub fn start_send(
self: Pin<&mut Drain<T>>,
_item: T
) -> Result<(), <Drain<T> as Sink<T>>::Error>
[src]
pub fn start_send(
self: Pin<&mut Drain<T>>,
_item: T
) -> Result<(), <Drain<T> as Sink<T>>::Error>
[src]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
impl<T> Unpin for Drain<T>
[src]
Auto Trait Implementations
impl<T> RefUnwindSafe for Drain<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for Drain<T> where
T: Send,
T: Send,
impl<T> Sync for Drain<T> where
T: Sync,
T: Sync,
impl<T> UnwindSafe for Drain<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
[src]
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
[src]Composes a function in front of the sink. Read more
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>>,
[src]
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>>,
[src]Composes a function in front of the sink. Read more
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
[src]
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
[src]Transforms the error returned by the sink.
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
[src]
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
[src]Map this sink’s error to a different error type using the Into
trait. Read more
fn buffer(self, capacity: usize) -> Buffer<Self, Item>
[src]
fn buffer(self, capacity: usize) -> Buffer<Self, Item>
[src]Adds a fixed-size buffer to the current sink. Read more
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]Fanout items to multiple sinks. Read more
fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ where
Self: Unpin,
[src]Flush the sink, processing all pending items. Read more
fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ where
Self: Unpin,
[src]A future that completes after the given item has been fully processed into the sink, including flushing. Read more
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ where
Self: Unpin,
[src]A future that completes after the given item has been received by the sink. Read more
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>ⓘ where
Self: Unpin,
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
[src]
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>ⓘ where
Self: Unpin,
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
[src]A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ where
Si2: Sink<Item, Error = Self::Error>,
[src]
fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ where
Si2: Sink<Item, Error = Self::Error>,
[src]Wrap this sink in an Either
sink, making it the left-hand variant
of that Either
. Read more
fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ where
Si1: Sink<Item, Error = Self::Error>,
[src]
fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ where
Si1: Sink<Item, Error = Self::Error>,
[src]Wrap this stream in an Either
stream, making it the right-hand variant
of that Either
. Read more
fn compat(self) -> CompatSink<Self, Item> where
Self: Unpin,
[src]
fn compat(self) -> CompatSink<Self, Item> where
Self: Unpin,
[src]fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]
fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]A convenience method for calling Sink::poll_ready
on Unpin
sink types. Read more
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]A convenience method for calling Sink::start_send
on Unpin
sink types. Read more