dart:async

StreamSubscription<T> класс

Подписка на события из Stream.

При прослушивании Stream с помощью Stream.listen возвращается объект StreamSubscription.

Подписка передаёт события обработчику и хранит функции обратного вызова, используемые для обработки этих событий. Подписку также можно использовать, чтобы отказаться от получения событий или временно приостановить их поступление из потока.

Пример:

final stream = Stream.periodic(const Duration(seconds: 1), (i) => i * i)
    .take(10);

final subscription = stream.listen(print); // A StreamSubscription<int>.

Чтобы приостановить подписку, используйте pause.

// Do some work.
subscription.pause();
print(subscription.isPaused); // true

Чтобы возобновить её после приостановки, используйте resume.

// Do some work.
subscription.resume();
print(subscription.isPaused); // false

Чтобы отменить подписку, используйте cancel.

// Do some work.
subscription.cancel();

Конструкторы

StreamSubscription()

Свойства

hashCode → int

только для чтенияунаследовано

Хеш-код этого объекта.

isPaused → bool

только для чтения

Приостановлена ли в данный момент подписка StreamSubscription.

runtimeType → Type

только для чтенияунаследовано

Представление типа объекта во время выполнения.

Методы

asFuture<E>([E? futureValue]) → Future<E>

Возвращает future, обрабатывающий обратные вызовы onDone и onError.

cancel() → Future<void>

Отменяет эту подписку.

noSuchMethod(Invocation invocation) → dynamic

унаследовано

Вызывается при обращении к несуществующему методу или свойству.

onData(void handleData(T data)?) → void

Заменяет обработчик событий с данными этой подписки.

onDone(void handleDone()?) → void

Заменяет обработчик события завершения этой подписки.

onError(Function? handleError) → void

Заменяет обработчик ошибок этой подписки.

pause([Future<void>? resumeSignal]) → void

Запрашивает приостановку передачи событий потоком до дальнейшего уведомления.

resume() → void

Возобновляет работу после приостановки.

toString() → String

унаследовано

Строковое представление этого объекта.

Операторы

operator ==(Object other) → bool

унаследовано

Оператор равенства.