listen 方法

StreamSubscription<T> listen(
  1. void onData(
    1. T value
    )?, {
  2. Function? onError,
  3. void onDone()?,
  4. bool? cancelOnError,
})
override

向此流添加一个订阅。

返回一个 StreamSubscription,该订阅使用提供的 onDataonErroronDone 处理器来处理此流的事件。可以在订阅上更改处理器,但它们最初是提供的函数。

对于来自此流的数据事件,将调用订阅者的 onData 处理器。如果 onDatanull,则不执行任何操作。

对于来自此流的错误,将使用错误对象和可能的事务跟踪调用 onError 处理器。

onError 回调必须为类型 void Function(Object error)void Function(Object error, StackTrace)。函数类型确定是否带有事务跟踪参数调用 onError。如果此流接收到的错误没有事务跟踪,则事务跟踪参数可能为 StackTrace.empty

否则,它将只带有错误对象调用。如果省略 onError,则认为此流上的任何错误都是未处理的,并将传递给当前 Zone 的错误处理器。默认情况下,未处理的异步错误被视为未捕获的顶级错误。

如果此流关闭并发送完成事件,则调用 onDone 处理器。如果 onDonenull,则不执行任何操作。

如果 cancelOnErrortrue,则在发送第一个错误事件时自动取消订阅。默认值为 false

在订阅暂停时,或者当订阅已被取消时,订阅不会收到事件,并且不会调用任何事件处理器函数。

实现

StreamSubscription<T> listen(void onData(T value)?,
    {Function? onError, void onDone()?, bool? cancelOnError}) {
  return _stream.listen(onData,
      onError: onError, onDone: onDone, cancelOnError: cancelOnError);
}