Struct futures_util::stream::SplitSink

pub struct SplitSink<S, Item> {
    lock: BiLock<S>,
    slot: Option<Item>,
}

A Sink part of the split pair

Fields

lock: BiLock<S>

slot: Option<Item>

Implementations

impl<S: Sink<Item> + Unpin, Item> SplitSink<S, Item>

pub fn reunite(self, other: SplitStream<S>) -> Result<S, ReuniteError<S, Item>>

Attempts to put the two “halves” of a split Stream + Sink back together. Succeeds only if the SplitStream<S> and SplitSink<S> are a matching pair originating from the same call to StreamExt::split.

impl<S, Item> SplitSink<S, Item>

pub fn is_pair_of(&self, other: &SplitStream<S>) -> bool

Returns true if the SplitStream<S> and SplitSink<S> originate from the same call to StreamExt::split.

impl<S: Sink<Item>, Item> SplitSink<S, Item>

fn poll_flush_slot( inner: Pin<&mut S>, slot: &mut Option<Item>, cx: &mut Context<'_>, ) -> Poll<Result<(), S::Error>>

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

Trait Implementations

impl<S: Debug, Item: Debug> Debug for SplitSink<S, Item>

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

Formats the value using the given formatter.

impl<S: Sink<Item>, Item> Sink<Item> for SplitSink<S, Item>

type Error = <S as Sink<Item>>::Error

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

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

Attempts to prepare the Sink to receive a value.

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

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

Flush any remaining output from this sink.

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

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

impl<S, Item> Unpin for SplitSink<S, Item>