default_controller

The controller passed to WritableStream sink callbacks. Use it to signal an error mid-stream via error or to observe the stream’s abort signal via signal. See gossamer/stream/writable_stream for constructing the stream.

Types

DefaultController

</>

A controller for a WritableStream’s underlying sink, passed to the start and write callbacks. Used to signal stream errors and access the abort signal.

See WritableStreamDefaultController on MDN.

pub type DefaultController

Values

error

</>

pub fn error(
  controller: DefaultController,
  reason reason: a,
) -> Nil

Signals an error on the stream. A no-op if the stream is already closed or errored.

signal

</>

pub fn signal(
  controller: DefaultController,
) -> abort_signal.AbortSignal

An AbortSignal that fires when the sink should abort its work (e.g., the consumer called writer.abort or writable_stream.abort).