RequestCancelledException class

Exception for intentionally cancelled HTTP requests.

Thrown when a request is explicitly cancelled, typically due to:

  • User navigating away from a screen
  • Timeout cancellation by the app
  • Request superseded by a newer request
  • App termination or backgrounding

This is a normal operational condition rather than an error, so it usually should not trigger error alerts or logging.

Example:

try {
  await cancelToken.cancel('User navigated away');
} catch (e) {
  if (e is RequestCancelledException) {
    // Silently ignore - this is expected
    return;
  }
}
Inheritance

Constructors

RequestCancelledException({String? message, DioException? originalException, String? errorCode, String? traceId})
Creates a RequestCancelledException with an optional custom message.
const

Properties

errorCode String?
A machine-readable error code from the backend's ErrorResponse envelope (e.g. VALIDATION_ERROR, TOO_MANY_REQUESTS), or null if the response body didn't match that schema.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
message String
A human-readable description of the error.
finalinherited
originalException DioException?
The underlying Dio exception that caused this network error.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
traceId String?
The backend's request-trace identifier from the ErrorResponse envelope, for correlating this error with server-side logs — or null if the response body didn't match that schema.
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
The string representation of this exception, including Dio-level details.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited