vexana
library
Classes
BackgroundTransformer
The default Transformer for Dio .
BaseOptions
A set of base settings for each Dio()
.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
CancelToken
Controls cancellation of Dio 's requests.
Dio
Dio enables you to make HTTP requests easily.
DioMixin
EmptyModel
EmptyModel is a model class that is used to
general model or primitive type.
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
ErrorModel <T extends INetworkModel <T > ? >
Error model for network response
FormData
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
FusedTransformer
A Transformer that has a fast path for decoding UTF8-encoded JSON.
If the response is utf8-encoded JSON and no custom decoder is specified in the RequestOptions , this transformer
is significantly faster than the default SyncTransformer and the BackgroundTransformer .
This improvement is achieved by using a fused Utf8Decoder and JsonDecoder to decode the response,
which is faster than decoding the utf8-encoded JSON in two separate steps, since
Dart uses a special fast decoder for this case.
See https://github.com/dart-lang/sdk/blob/5b2ea0c7a227d91c691d2ff8cbbeb5f7f86afdb9/sdk/lib/_internal/vm/lib/convert_patch.dart#L40
The headers class for requests and responses.
HttpClientAdapter
HttpAdapter
is a bridge between Dio and HttpClient .
IErrorModel <T extends INetworkModel <T > ? >
Error model for network response
IFileManager
Interface for file manager
INetworkManager <E extends INetworkModel <E > >
The INetworkManager
interface is used to define the methods that are used
to send HTTP requests to a server. It extends the NetworkManagerParameters
INetworkModel <T >
Interface for network model
Interceptor
Interceptor helps to deal with RequestOptions , Response ,
and DioException during the lifecycle of a request
before it reaches users.
Interceptors
A Queue-Model list for Interceptor s.
InterceptorState <T >
Used to pass state between interceptors.
InterceptorsWrapper
A helper class to create interceptors in ease.
IResponseModel <T , E extends INetworkModel <E > ? >
This response model is used to represent the response received from the
server. It contains a data
field which represents the data received
from the server, and an error
field which represents any errors that
occurred while receiving the data.
ListParam <T >
Indicates a param being used as queries or form data,
and how does it gets formatted.
LocalFile
Local file manager for a document folder
LocalPreferences
Manage cache with shared package
LogInterceptor
LogInterceptor is used to print logs during network requests.
It should be the last interceptor added,
otherwise modifications by following interceptors will not be logged.
This is because the execution of interceptors is in the order of addition.
MultipartFile
An upload content that is a part of MultipartRequest
.
This doesn't need to correspond to a physical file.
NetworkErrorResult <T , E extends INetworkModel <E > >
NetworkErrorResult is a class representing a failed network request.
NetworkManager <E extends INetworkModel <E > >
Network manager provide your requests with Dio
NetworkResult <T , E extends INetworkModel <E > >
NetworkResult is a sealed class representing the result of a request.
It can either be a success or an error result.
This class provides utility methods to check the result type
and to handle the result using a functional approach.
NetworkSuccessResult <T , E extends INetworkModel <E > >
NetworkSuccessResult is a class representing a successful network request.
NoNetwork
NoNetwork model class
NoNetworkManager
No network manager
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor in ease.
RedirectRecord
A record that records the redirection happens during requests,
including status code, request method, and the location.
RequestInterceptorHandler
The handler for interceptors to handle before the request has been sent.
RequestOptions
The internal request option class that is the eventual result after
BaseOptions and Options are composed.
Response <T >
The Response class contains the payload (could be transformed)
that respond from the request, and other information of the response.
ResponseBody
The response wrapper class for adapters.
ResponseInterceptorHandler
The handler for interceptors to handle after respond.
ResponseModel <T , E extends INetworkModel <E > ? >
Response model for network response general
SyncTransformer
If you want to custom the transformation of request/response data,
you can provide a Transformer by your self, and replace
the transformer by setting the Dio.transformer .
Transformer
Transformer allows changes to the request/response data before
it is sent/received to/from the server.
Enums
DioExceptionType
The exception enumeration indicates what type of exception
has happened during requests.
FileAccessMode
The file access mode when downloading a file, corresponds to a subset of
dart:io::FileMode .
InterceptorResultType
The result type after handled by the interceptor.
ListFormat
Specifies the array format (a single parameter with multiple parameter
or multiple parameters with the same name).
and the separator for array items.
RequestType
RequestType is enum class for NetworkManager request type.
ResponseType
Indicates which transformation should be applied to the response data.