DioResultHandler class

A Result-returning wrapper around a Dio instance — the recommended integration for production apps.

Beyond the standard verbs it adds:

  • upload for multipart/form-data requests with progress callbacks.
  • download for streaming a response body to disk with progress callbacks.
  • Granular failure mapping for every DioExceptionType.

Constructors

DioResultHandler(Dio _dio)
Wraps an existing Dio instance. Pass your own client so that interceptors, base URLs, and adapter configuration remain in one place.
const

Properties

dio → Dio
The underlying Dio client. Exposed so callers can attach interceptors (e.g. ResultLoggerInterceptor).
no setter
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

delete<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, required DioJsonParser<T> parser}) → Future<Result<T>>
Performs a DELETE.
download(String path, String savePath, {Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, void onReceiveProgress(int received, int total)?}) → Future<Result<void>>
Downloads the response body for path to savePath.
get<T>(String path, {Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, required DioJsonParser<T> parser}) → Future<Result<T>>
Performs a GET and decodes via parser.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, required DioJsonParser<T> parser}) → Future<Result<T>>
Performs a PATCH.
post<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, required DioJsonParser<T> parser}) → Future<Result<T>>
Performs a POST.
put<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, required DioJsonParser<T> parser}) → Future<Result<T>>
Performs a PUT.
toString() → String
A string representation of this object.
inherited
upload<T>(String path, {required FormData formData, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, void onSendProgress(int sent, int total)?, required DioJsonParser<T> parser}) → Future<Result<T>>
Uploads formData to path using multipart/form-data.

Operators

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