Type alias Signal<T>

Signal<T>: Start<T> | Push<T> | End

Signals are sent from Sources to Sinks to inform them of changes.

Remarks

A Source, when consumed, sends a sequence of events to Sinks. In order, a Start signal will always be sent first, followed optionally by one or more Push signals, carrying values and representing the stream. A Source will send the End signal when it runs out of values. The End signal will be omitted if the Source is cancelled by a Close signal, sent back from the Sink.

See

  • SignalKind for the kinds signals sent by Sources.
  • Start for the data structure of the start signal.
  • Push for the data structure of the push signal.

Type Parameters

  • T

Generated using TypeDoc