Struct futures_util::sink::With

#[must_use = "sinks do nothing unless polled"]pub struct With<Si, Item, U, Fut, F> { /* fields omitted */ }

This is supported on crate feature sink only.

Sink for the with method.

Implementations

impl<Si, Item, U, Fut, F, E> With<Si, Item, U, Fut, F> where
    Si: Sink<Item>,
    F: FnMut(U) -> Fut,
    Fut: Future<Output = Result<Item, E>>,
    E: From<Si::Error>, 

pub fn get_ref(&self) -> &Si

Acquires a reference to the underlying sink or stream that this combinator is pulling from.

pub fn get_mut(&mut self) -> &mut Si

Acquires a mutable reference to the underlying sink or stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the sink or stream which may otherwise confuse this combinator.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut Si>

Acquires a pinned mutable reference to the underlying sink or stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the sink or stream which may otherwise confuse this combinator.

pub fn into_inner(self) -> Si

Consumes this combinator, returning the underlying sink or stream.

Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.

Trait Implementations

impl<Si, Item, U, Fut, F> Clone for With<Si, Item, U, Fut, F> where
    Si: Clone,
    F: Clone,
    Fut: Clone, 

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Si, Item, U, Fut, F> Debug for With<Si, Item, U, Fut, F> where
    Si: Debug,
    Fut: Debug, 

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

Formats the value using the given formatter.

impl<Si, Item, U, Fut, F, E> Sink<U> for With<Si, Item, U, Fut, F> where
    Si: Sink<Item>,
    F: FnMut(U) -> Fut,
    Fut: Future<Output = Result<Item, E>>,
    E: From<Si::Error>, 

type Error = E

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

pub fn poll_ready(
    mut self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

pub fn start_send(self: Pin<&mut Self>, item: U) -> Result<(), Self::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(())).

pub fn poll_flush(
    mut self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

pub fn poll_close(
    mut self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

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

impl<S, Item, U, Fut, F> Stream for With<S, Item, U, Fut, F> where
    S: Stream + Sink<Item>,
    F: FnMut(U) -> Fut,
    Fut: Future, 

type Item = S::Item

Values yielded by the stream.

pub fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, Si, Item, U, Fut, F> Unpin for With<Si, Item, U, Fut, F> where
    __Origin<'__pin, Si, Item, U, Fut, F>: Unpin,