getStreamResultsInTimeLimit<T> function

Future<List<T>> getStreamResultsInTimeLimit<T>(
  1. Stream<T> stream,
  2. Duration timeout
)

Returns a list of results from a stream in a time limit.

Parameters:

  • stream: The stream from which to obtain the results.
  • timeout: The time limit in milliseconds.

Returns:

A list of results.

Example:

// Creates a stream that emits numbers
Stream<int> generateNumbers() async* {
  for (int i = 0; i < 10; i++) {
    await Future.delayed(Duration(seconds: 1));
    yield i;
  }
}

// Gets the results of the stream in a time limit of 5 seconds
Future<List<int>> results = getStreamResultsInTimeLimit(generateNumbers(), 5000);

// Prints the results
await results.then((list) {
  print(list);
});

Output:

[0, 1, 2, 3, 4, 5]

Implementation

Future<List<T>> getStreamResultsInTimeLimit<T>(
  Stream<T> stream,
  Duration timeout,
) async {
  // Creates a list to store the results
  final results = <T>[];

  // Subscribes to the stream
  final subscription = stream.listen(results.add);

  // Starts a timer
  Timer(timeout, subscription.cancel);
  // Waits for the stream to finish emitting events
  // ignore: inference_failure_on_function_invocation
  return Future.delayed(timeout, () {
    return results;
  });
}