Struct wasm_streams::writable::WritableStream [−][src]
pub struct WritableStream { /* fields omitted */ }
Expand description
WritableStream
s can be created from a raw JavaScript stream with
from_raw
, or from a Rust Sink
with from_sink
.
They can be converted into a raw JavaScript stream with
into_raw
, or into a Rust Sink
with into_sink
.
Implementations
Creates a new WritableStream
from a JavaScript stream.
Creates a new WritableStream
from a Sink
.
Items and errors must be represented as raw JsValue
s.
Use with
and/or sink_map_err
to convert a sink’s items to a JsValue
before passing it to this function.
Acquires a reference to the underlying JavaScript stream.
Consumes this WritableStream
, returning the underlying JavaScript stream.
Returns true
if the stream is locked to a writer.
Aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an errored state, with any queued-up writes discarded.
If the stream is currently locked to a writer, then this returns an error.
Aborts the stream with the
given reason
, signaling that the producer can no longer successfully write to the stream
and it is to be immediately moved to an errored state, with any queued-up writes discarded.
If the stream is currently locked to a writer, then this returns an error.
Creates a writer and locks the stream to the new writer.
While the stream is locked, no other writer can be acquired until this one is released.
Panics if the stream is already locked to a writer. For a non-panicking variant,
use try_get_writer
.
Converts this WritableStream
into a Sink
.
Items and errors are represented by their raw JsValue
.
Use with
and/or sink_map_err
on the returned stream to convert them to a more appropriate type.
Panics if the stream is already locked to a writer. For a non-panicking variant,
use try_into_sink
.
Try to convert this WritableStream
into a Sink
.
Items and errors are represented by their raw JsValue
.
Use with
and/or sink_map_err
on the returned stream to convert them to a more appropriate type.
If the stream is already locked to a writer, then this returns an error
along with the original WritableStream
.