gossamer/readable_stream/reader

Types

A locked reader over a ReadableStream.

See ReadableStreamDefaultReader on MDN.

pub type Reader(a)

Values

pub fn cancel(
  reader: Reader(a),
  reason reason: r,
) -> promise.Promise(Result(Nil, js_error.JsError))

Cancels the stream and releases the reader’s lock. Returns an error if the underlying cancel fails.

pub fn closed(
  of reader: Reader(a),
) -> promise.Promise(Result(Nil, js_error.JsError))

Resolves when the stream closes. Returns an error if the stream errored.

pub fn read(
  reader: Reader(a),
) -> promise.Promise(
  Result(read_result.ReadResult(a), js_error.JsError),
)

Reads the next chunk from the stream. Returns an error if the stream errored or the reader was released.

pub fn release_lock(
  reader: Reader(a),
) -> Result(Reader(a), js_error.JsError)

Releases the reader’s lock on the stream. Returns an error if the reader has outstanding read requests.

Search Document