Struct IntoSink

pub struct IntoSink<'writer> { /* private fields */ }

A Sink for the into_sink method.

This sink holds a writer, and therefore locks the WritableStream. When this sink is dropped, it also drops its writer which in turn releases its lock.

Implementations

impl<'writer> IntoSink<'writer>

pub async fn abort(self) -> Result<(), JsValue>

Aborts the stream, signaling that the producer can no longer successfully write to the stream.

pub async fn abort_with_reason(self, reason: &JsValue) -> Result<(), JsValue>

Aborts the stream, signaling that the producer can no longer successfully write to the stream.

Trait Implementations

impl<'writer> Debug for IntoSink<'writer>

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

Formats the value using the given formatter.

impl<'writer> Sink<JsValue> for IntoSink<'writer>

type Error = JsValue

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

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

Attempts to prepare the Sink to receive a value.

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

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

Flush any remaining output from this sink.

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

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