ext
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 .
BoolList
A space-efficient list of boolean values.
CancelToken
Controls cancellation of Dio 's requests.
CanonicalizedMap <C , K , V >
A map whose keys are converted to canonical values of type C.
CaseInsensitiveEquality
String equality that's insensitive to differences in ASCII case.
CombinedIterableView <T >
A view of several iterables combined sequentially into a single iterable.
CombinedListView <T >
A view of several lists combined into a single list.
CombinedMapView <K , V >
Returns a new map that represents maps flattened into a single map.
DeepCollectionEquality
Deep equality on collections.
DefaultEquality <E >
Equality of objects that compares only the natural equality of the objects.
DelegatingIterable <E >
An Iterable that delegates all operations to a base iterable.
DelegatingList <E >
A List that delegates all operations to a base list.
DelegatingMap <K , V >
A Map that delegates all operations to a base map.
DelegatingQueue <E >
A Queue that delegates all operations to a base queue.
DelegatingSet <E >
A Set that delegates all operations to a base set.
Dio
Dio enables you to make HTTP requests easily.
DioMixin
ElLinkedList <N extends ElLinkedNode <N > >
双向链表
ElLinkedNode <N extends ElLinkedNode <N > >
双向链表节点对象，你需要继承此类才能在 ElLinkedList 中使用：
Equality <E >
A generic equality relation on objects.
EqualityBy <E , F >
Equality of objects based on derived values.
EqualityMap <K , V >
A Map whose key equality is determined by an Equality object.
EqualitySet <E >
A Set whose key equality is determined by an Equality object.
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
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.
HeapPriorityQueue <E >
Heap based priority queue.
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient .
IdentityEquality <E >
Equality of objects that compares only the identity of the objects.
Immutable
Annotation on an immutable class.
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.
InterceptorsWrapper
A helper class to create interceptors in ease.
IterableEquality <E >
Equality on iterables.
IterableZip <T >
Iterable that iterates over lists of values from other iterables.
ListEquality <E >
Equality on lists.
ListParam <T >
Indicates a param being used as queries or form data,
and how does it gets formatted.
ListSlice <E >
A list view of a range of another list.
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.
MapEquality <K , V >
Equality on maps.
MapKeySet <E >
An unmodifiable Set view of the keys of a Map .
MapValueSet <K , V >
Creates a modifiable Set view of the values of a Map .
MultiEquality <E >
Combines several equalities into a single equality.
MultipartFile
An upload content that is a part of MultipartRequest.
This doesn't need to correspond to a physical file.
NonGrowableListMixin <E >
Mixin class that implements a throwing version of all list operations that
change the List's length.
NonGrowableListView <E >
A fixed-length list.
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
PriorityQueue <E >
A priority queue is a priority based work-list of elements.
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor in ease.
QueueList <E >
A class that efficiently implements both Queue and List .
RecordUse
Annotation on a statically resolved member or class whose usages will be
recorded.
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.
Required
Annotation on a required named parameter.
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.
SetEquality <E >
Equality of sets.
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 .
Target
An annotation used on classes that are intended to be used as annotations
to indicate the kinds of declarations and directives for which the
annotation is appropriate.
TargetKind
An enumeration of the kinds of targets to which an annotation can be
applied.
Transformer
Transformer allows changes to the request/response data before
it is sent/received to/from the server.
UnionSet <E >
A single set that provides a view of the union over a set of sets.
UnionSetController <E >
A controller that exposes a view of the union of a collection of sets.
UnmodifiableListView <E >
An unmodifiable List view of another List.
UnmodifiableMapMixin <K , V >
Mixin class that implements a throwing version of all map operations that
change the Map.
UnmodifiableMapView <K , V >
View of a Map that disallow modifying the map.
UnmodifiableSetMixin <E >
Mixin class that implements a throwing version of all set operations that
change the Set.
UnmodifiableSetView <E >
An unmodifiable set.
UnorderedIterableEquality <E >
Equality of the elements of two iterables without considering order.
UseResult
Annotation on function or property whose value must not be ignored.
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 .
ListFormat
Specifies the array format (a single parameter with multiple parameter
or multiple parameters with the same name).
and the separator for array items.
ResponseType
Indicates which transformation should be applied to the response data.
Mixins
OptionsMixin
The mixin class for options that provides common attributes.
Constants
alwaysThrows → const Object
Annotation marking a function as always throwing.
awaitNotRequired → const Object
Annotation on asynchronous function whose Future can be ignored.
checked → const Object
Annotation that no longer has any effect.
doNotStore → const Object
Annotation on function or property whose value must not be stored.
doNotSubmit → const Object
Annotation marking declaration that should be removed before publishing.
experimental → const Object
Annotation marking declaration as experimental and subject to change.
factory → const Object
Annotation on a function that creates new objects.
immutable → const Immutable
Annotation on an immutable class.
internal → const Object
Annotation on declaration that should not be used outside of its package.
isTest → const Object
Annotation on a test framework function that introduces a single test.
isTestGroup → const Object
Annotation on a test framework function that introduces a group of tests.
literal → const Object
Annotation on constructor that must be invoked with const if possible.
mustBeConst → const Object
Annotation on a parameter whose arguments must be constants.
mustBeOverridden → const Object
Annotation on instance members that must be overridden by subclasses.
mustCallSuper → const Object
Annotation on instance member that overriding members must call.
nonVirtual → const Object
Annotation on instance member that must not be overridden.
optionalTypeArgs → const Object
Annotation on type arguments that can safely be omitted.
protected → const Object
Annotation on instance member that should only be used by subclasses.
redeclare → const Object
Annotation on extension type members which redeclare superinterface members.
reopen → const Object
Annotation on declaration with less access restrictions than superinterface.
required → const Required
Annotation on named parameter that should always have an argument supplied.
sealed → const Object
Annotation on class that must not be subclassed outside of its package.
useResult → const UseResult
Annotation on function or property whose value must not be ignored.
virtual → const Object
Annotation which no longer has any effect.
visibleForOverriding → const Object
Annotation on declaration that should not be used outside of its package.
visibleForTesting → const Object
Annotation on a public declaration that should only be used in tests.
Functions
binarySearch <E > (List <E > sortedList , E value , {int compare (E , E → int
Returns a position of the value in sortedList, if it is there.
compareAsciiLowerCase (String a , String b → int
Compares a and b lexically, converting ASCII letters to lower case.
compareAsciiLowerCaseNatural (String a , String b → int
Compares strings a and b according to lower-case
natural sort ordering .
compareAsciiUpperCase (String a , String b → int
Compares a and b lexically, converting ASCII letters to upper case.
compareAsciiUpperCaseNatural (String a , String b → int
Compares strings a and b according to upper-case
natural sort ordering .
compareNatural (String a , String b → int
Compares strings a and b according to natural sort ordering .
defaultDioExceptionReadableStringBuilder (DioException e → String
The default implementation of building a readable string of DioException .
equalsIgnoreAsciiCase (String a , String b → bool
Checks if strings a and b differ only on the case of ASCII letters.
groupBy <S , T > (Iterable <S > values , T key (S → Map <T , List <S >
Groups the elements in values by the value returned by key.
hashIgnoreAsciiCase (String string → int
Hash code for a string which is compatible with equalsIgnoreAsciiCase .
insertionSort <E > (List <E > elements , {int compare (E , E int start = 0 , int ?end → void
Sort a list between start (inclusive) and end (exclusive) using
insertion sort.
lastBy <S , T > (Iterable <S > values , T key (S → Map <T , S >
Associates the elements in values by the value returned by key.
lowerBound <E > (List <E > sortedList , E value , {int compare (E , E → int
Returns the first position in sortedList that does not compare less than
value.
mapMap <K1 , V1 , K2 , V2 > (Map <K1 , V1 > map , {K2 key (K1 , V1 V2 value (K1 , V1 → Map <K2 , V2 >
Creates a new map from map with new keys and values.
maxBy <S , T > (Iterable <S > values , T orderBy (S int compare (T , T → S?
Returns the element of values for which orderBy returns the maximum
value.
mergeMaps <K , V > (Map <K , V > map1 , Map <K , V > map2 , {V value (V , V → Map <K , V >
Returns a new map with all key/value pairs in both map1 and map2.
mergeSort <E > (List <E > elements , {int start = 0 , int ?end , int compare (E , E → void
Sorts a list between start (inclusive) and end (exclusive) using the
merge sort algorithm.
minBy <S , T > (Iterable <S > values , T orderBy (S int compare (T , T → S?
Returns the element of values for which orderBy returns the minimum
value.
reverse <E > (List <E > elements , [int start = 0 , int ?end → void
Reverses a list, or a part of a list, in-place.
shuffle (List elements , [int start = 0 , int ?end , Random ?random → void
Shuffles a list randomly.
stronglyConnectedComponents <T > (Map <T , Iterable <T > graph → List <Set <T >
Returns the strongly connected components of graph, in topological
order.
transitiveClosure <T > (Map <T , Iterable <T > graph → Map <T , Set <T >
Returns the transitive closure of graph.
