default_controller

Types

DefaultController

A controller for a ReadableStream’s default source, passed to the Start and Pull callbacks. Used to enqueue chunks, close the stream, or signal an error.

See ReadableStreamDefaultController on MDN.

pub type DefaultController(a)

Values

close

</>

pub fn close(
  controller: DefaultController(a),
) -> Result(Nil, js_error.JsError)

Closes the stream. Returns an error if the stream is already closed or errored.

desired_size

</>

pub fn desired_size(
  of controller: DefaultController(a),
) -> Result(Int, Nil)

The desired size to fill the stream’s internal queue. Returns an error if the stream has been closed or errored.

enqueue

</>

pub fn enqueue(
  in controller: DefaultController(a),
  chunk chunk: a,
) -> Result(Nil, js_error.JsError)

Enqueues chunk into the stream’s internal queue. Returns an error if the stream is closed or errored.

error

</>

pub fn error(
  controller: DefaultController(a),
  reason reason: b,
) -> Result(Nil, js_error.JsError)

Signals an error on the stream. Returns an error if the stream is already closed or errored.