Struct futures::sink::Drain [−][src]
#[must_use = "sinks do nothing unless polled"]pub struct Drain<T> { /* fields omitted */ }
Sink for the drain function.
Trait Implementations
impl<T> Debug for Drain<T> where
T: Debug, [src][+]
T: Debug,
pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src][−]
Formats the value using the given formatter. Read more
impl<T> Sink<T> for Drain<T>[src][+]
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][−]
self: Pin<&mut Drain<T>>,
_cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>
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][−]
self: Pin<&mut Drain<T>>,
_item: T
) -> Result<(), <Drain<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
pub fn poll_flush(
self: Pin<&mut Drain<T>>,
_cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>[src][−]
self: Pin<&mut Drain<T>>,
_cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>
Flush any remaining output from this sink. Read more
pub fn poll_close(
self: Pin<&mut Drain<T>>,
_cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>[src][−]
self: Pin<&mut Drain<T>>,
_cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>
Flush any remaining output and close this sink, if necessary. 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> Any for T where
T: 'static + ?Sized, [src][+]
T: 'static + ?Sized,
pub fn type_id(&self) -> TypeId[src][−]
Gets the TypeId of self. Read more
impl<T> Borrow<T> for T where
T: ?Sized, [src][+]
T: ?Sized,
pub fn borrow(&self) -> &Tⓘ[src][−]
Immutably borrows from an owned value. Read more
impl<T> BorrowMut<T> for T where
T: ?Sized, [src][+]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut Tⓘ[src][−]
Mutably borrows from an owned value. Read more
impl<T> From<T> for T[src][+]
impl<T, U> Into<U> for T where
U: From<T>, [src][+]
U: From<T>,
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized, [src][+]
T: Sink<Item> + ?Sized,
pub 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][−]
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
Composes a function in front of the sink. Read more
pub 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][−]
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
Composes a function in front of the sink. Read more
pub fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E, [src][−]
F: FnOnce(Self::Error) -> E,
Transforms the error returned by the sink.
pub fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>, [src][−]
Self::Error: Into<E>,
Map this sink’s error to a different error type using the Into trait. Read more
pub fn buffer(self, capacity: usize) -> Buffer<Self, Item>[src][−]
Adds a fixed-size buffer to the current sink. Read more
pub fn close(&mut self) -> Close<'_, Self, Item>ⓘ where
Self: Unpin, [src][−]
Self: Unpin,
Close the sink.
pub fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>, [src][−]
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
Fanout items to multiple sinks. Read more
pub fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ where
Self: Unpin, [src][−]
Self: Unpin,
Flush the sink, processing all pending items. Read more
pub fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ where
Self: Unpin, [src][−]
Self: Unpin,
A future that completes after the given item has been fully processed into the sink, including flushing. Read more
pub fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ where
Self: Unpin, [src][−]
Self: Unpin,
A future that completes after the given item has been received by the sink. Read more
pub 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][−]
Self: Unpin,
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
pub fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ where
Si2: Sink<Item, Error = Self::Error>, [src][−]
Si2: Sink<Item, Error = Self::Error>,
Wrap this sink in an Either sink, making it the left-hand variant
of that Either. Read more
pub fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ where
Si1: Sink<Item, Error = Self::Error>, [src][−]
Si1: Sink<Item, Error = Self::Error>,
Wrap this stream in an Either stream, making it the right-hand variant
of that Either. Read more
pub fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin, [src][−]
&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
pub fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin, [src][−]
Self: Unpin,
A convenience method for calling Sink::start_send on Unpin
sink types. Read more
pub fn poll_flush_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin, [src][−]
&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
pub fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin, [src][−]
&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
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src][+]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src][−]
Performs the conversion.
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src][+]
U: TryFrom<T>,