cancel — абстрактный метод
Досрочно отменяет итератор потока (и лежащую в его основе подписку на поток).
Итератор потока автоматически отменяется, если future-объект moveNext завершается с результатом false или с ошибкой.
Если вам нужно прекратить получение значений до автоматического закрытия итератора потока, вызовите cancel, чтобы поток был корректно закрыт.
Если при отмене итератора был вызван moveNext, возвращённый им future-объект завершится со значением false, как и все последующие вызовы moveNext.
Возвращает future-объект, который завершается после завершения отмены. Если отмена происходит синхронно, этот future-объект может быть уже завершён.
Реализация
Future cancel();
© 2012 the Dart project authors
Licensed under the BSD 3-Clause "New" or "Revised" License.
https://api.dart.dev/stable/2.19.6/dart-async/StreamIterator/cancel.html