CancellationToken class

A token that can be used to cancel asynchronous operations.

Pass a CancellationToken to search operations to allow cancelling long-running searches when the user types a new query or navigates away.

Example:

class MySearchProvider extends SearchProvider {
  CancellationToken? _activeToken;

  @override
  Future<SearchResult> search(
    String query, {
    int page = 1,
    int pageSize = 10,
    CancellationToken? cancellationToken,
  }) async {
    // Cancel previous search
    _activeToken?.cancel();
    _activeToken = cancellationToken ?? CancellationToken();

    try {
      final response = await http.get(buildUrl(query));

      // Check if cancelled before processing
      if (_activeToken!.isCancelled) {
        throw CancelledException();
      }

      return parseResponse(response);
    } catch (e) {
      if (_activeToken?.isCancelled ?? false) {
        return SearchResult.empty(query);
      }
      rethrow;
    }
  }
}