imports/dart_package_imports
library
Classes
-
AbstractConnectableStream<T, S extends Subject<T>, R extends Stream<T>>
-
Base class for implementations of ConnectableStream.
S
is type of the forwarding Subject.
R
is return type of autoConnect and refCount (type constraint: S extends R
).
-
AndroidBuildVersion
-
Version values of the current Android operating system build derived from
android.os.Build.VERSION
.
-
AndroidDeviceInfo
-
Information derived from
android.os.Build
.
-
BackgroundTransformer
-
The default Transformer for Dio.
-
BaseDeviceInfo
-
The base class for platform's device info.
-
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.
-
BehaviorSubject<T>
-
A special StreamController that captures the latest item that has been
added to the controller, and emits that as the first item to any new
listener.
-
Bidi
-
This provides utility methods for working with bidirectional text. All
of the methods are static, and are organized into a class primarily to
group them together for documentation and discoverability.
-
BidiFormatter
-
Bidi stands for Bi-directional text. According to
Wikipedia:
Bi-directional text is text containing text in both text directionalities,
both right-to-left (RTL) and left-to-right (LTR). It generally involves text
containing different types of alphabets, but may also refer to
boustrophedon, which is changing text directionality in each row.
-
Bloc<Event, State>
-
Takes a
Stream
of Events
as input
and transforms them into a Stream
of States
as output.
-
BlocBase<State>
-
An interface for the core functionality implemented by
both Bloc and Cubit.
-
BlocBuilder<B extends StateStreamable<S>, S>
-
BlocBuilder handles building a widget in response to new
states
.
BlocBuilder is analogous to StreamBuilder but has simplified API to
reduce the amount of boilerplate code needed as well as bloc-specific
performance improvements.
Please refer to BlocListener if you want to "do" anything in response to
state
changes such as navigation, showing a dialog, etc...
-
BlocBuilderBase<B extends StateStreamable<S>, S>
-
Base class for widgets that build themselves based on interaction with
a specified bloc.
-
BlocConsumer<B extends StateStreamable<S>, S>
-
BlocConsumer exposes a builder and listener in order react to new
states.
BlocConsumer is analogous to a nested
BlocListener
and BlocBuilder
but reduces the amount of boilerplate needed.
BlocConsumer should only be used when it is necessary to both rebuild UI
and execute other reactions to state changes in the bloc.
-
BlocEventSink<Event extends Object?>
-
An ErrorSink that supports adding events.
-
BlocListener<B extends StateStreamable<S>, S>
-
Takes a BlocWidgetListener and an optional bloc and invokes
the listener in response to
state
changes in the bloc.
It should be used for functionality that needs to occur only in response to
a state
change such as navigation, showing a SnackBar
, showing
a Dialog
, etc...
The listener is guaranteed to only be called once for each state
change
unlike the builder
in BlocBuilder
.
-
BlocListenerBase<B extends StateStreamable<S>, S>
-
Base class for widgets that listen to state changes in a specified bloc.
-
BlocObserver
-
An interface for observing the behavior of Bloc instances.
-
BlocProvider<T extends StateStreamableSource<Object?>>
-
Takes a
create
function that is responsible for
creating the Bloc or Cubit and a child which will have access
to the instance via BlocProvider.of(context)
.
It is used as a dependency injection (DI) widget so that a single instance
of a Bloc or Cubit can be provided to multiple widgets within a subtree.
-
BlocSelector<B extends StateStreamable<S>, S, T>
-
BlocSelector is analogous to BlocBuilder but allows developers to
filter updates by selecting a new value based on the bloc state.
Unnecessary builds are prevented if the selected value does not change.
-
BufferCountStreamTransformer<T>
-
Buffers a number of values from the source Stream by count then
emits the buffer and clears it, and starts a new buffer each
startBufferEvery values. If startBufferEvery is not provided,
then new buffers are started immediately at the start of the source
and when each buffer closes and is emitted.
-
BufferStreamTransformer<T>
-
Creates a Stream where each item is a List containing the items
from the source sequence.
-
BufferTestStreamTransformer<T>
-
Creates a Stream where each item is a List containing the items
from the source sequence, batched whenever test passes.
-
Builder<V extends Built<V, B>, B extends Builder<V, B>>
-
Every Built class has a corresponding Builder class.
-
Built<V extends Built<V, B>, B extends Builder<V, B>>
-
Implement this for a Built Value.
-
BuiltList<E>
-
The Built Collection List.
-
BuiltListMultimap<K, V>
-
The Built Collection
ListMultimap
.
-
BuiltMap<K, V>
-
The Built Collection Map.
-
BuiltSet<E>
-
The Built Collection Set.
-
BuiltSetMultimap<K, V>
-
The Built Collection
SetMultimap
.
-
BuiltValue
-
Optionally, annotate a Built Value with this to specify settings. This is
only needed for advanced use.
-
BuiltValueEnum
-
Optionally, annotate an
EnumClass
with this to specify settings. This
is only needed for advanced use.
-
BuiltValueEnumConst
-
Optionally, annotate an
EnumClass
constant with this to specify settings.
This is only needed for advanced use.
-
BuiltValueField
-
Optionally, annotate a Built Value field with this to specify settings.
This is only needed for advanced use.
-
BuiltValueHook
-
Optionally, annotate methods with this to cause them to be called by
generated code.
-
BuiltValueSerializer
-
Optionally, annotate a Built Value
Serializer
getters with this to
specify settings. This is only needed for advanced use.
-
BuiltValueToStringHelper
-
Interface for built_value toString() output helpers.
-
CancelToken
-
Controls cancellation of Dio's requests.
-
Change<State>
-
A Change represents the change from one
State
to another.
A Change consists of the currentState and nextState.
-
Closable
-
An object that must be closed when no longer in use.
-
CombineLatestStream<T, R>
-
Merges the given Streams into one Stream sequence by using the
combiner function whenever any of the source stream sequences emits an
item.
-
CompositeSubscription
-
Acts as a container for multiple subscriptions that can be canceled at once
e.g. view subscriptions in Flutter that need to be canceled on view disposal
-
ConcatEagerStream<T>
-
Concatenates all of the specified stream sequences, as long as the
previous stream sequence terminated successfully.
-
ConcatStream<T>
-
Concatenates all of the specified stream sequences, as long as the
previous stream sequence terminated successfully.
-
ConnectableStream<T>
-
A ConnectableStream resembles an ordinary Stream, except that it
can be listened to multiple times and does not begin emitting items when
it is listened to, but only when its connect method is called.
-
ConnectableStreamSubscription<T>
-
A special StreamSubscription that not only cancels the connection to
the source Stream, but also closes down a subject that drives the Stream.
-
Connectivity
-
Discover network connectivity configurations: Distinguish between WI-FI and cellular, check WI-FI status and more.
-
ConnectivityPlusLinuxPlugin
-
The Linux implementation of ConnectivityPlatform.
-
Cubit<State>
-
A Cubit is similar to Bloc but has no notion of events
and relies on methods to emit new states.
-
DataNotification<T>
-
A notification representing a data event from a Stream.
-
DateFormat
-
DateFormat is for formatting and parsing dates in a locale-sensitive
manner.
-
DebounceStreamTransformer<T>
-
Transforms a Stream so that will only emit items from the source sequence
if a window has completed, without the source sequence emitting
another item.
-
DefaultIfEmptyStreamTransformer<S>
-
Emit items from the source Stream, or a single default item if the source
Stream emits nothing.
-
DeferStream<T>
-
The defer factory waits until a listener subscribes to it, and then it
creates a Stream with the given factory function.
-
DelayStreamTransformer<S>
-
The Delay operator modifies its source Stream by pausing for
a particular increment of time (that you specify) before emitting
each of the source Stream’s items.
This has the effect of shifting the entire sequence of items emitted
by the Stream forward in time by that specified increment.
-
DelayWhenStreamTransformer<T>
-
Delays the emission of items from the source Stream by a given time span
determined by the emissions of another Stream.
-
DematerializeStreamTransformer<S>
-
Converts the onData, onDone, and onError StreamNotification objects from a
materialized stream into normal onData, onDone, and onError events.
-
DeviceInfoPlugin
-
Provides device and operating system information.
-
DeviceInfoPlusLinuxPlugin
-
See
DeviceInfoPlatform
-
DeviceInfoPlusWindowsPlugin
-
The Windows implementation of
DeviceInfoPlatform
.
-
Dio
-
Dio enables you to make HTTP requests easily.
-
DioMixin
-
-
DistinctUniqueStreamTransformer<S>
-
Create a Stream which implements a HashSet under the hood, using
the provided
equals
as equality.
-
DoneNotification
-
A notification representing a done event from a Stream.
-
DoStreamTransformer<S>
-
Invokes the given callback at the corresponding point the the stream
lifecycle. For example, if you pass in an onDone callback, it will
be invoked when the stream finishes emitting items.
-
Emittable<State extends Object?>
-
An object that can emit new states.
-
EmittableStateStreamableSource<State>
-
A StateStreamableSource that can emit new states.
-
Emitter<State>
-
An Emitter is a class which is capable of emitting new states.
-
EndWithManyStreamTransformer<S>
-
Appends a sequence of values to the source Stream.
-
EndWithStreamTransformer<S>
-
Appends a value to the source Stream before closing.
-
EnumClass
-
Enum Class base class.
-
ErrorAndStackTrace
-
An Object which acts as a tuple containing both an error and the
corresponding stack trace.
-
ErrorInterceptorHandler
-
The handler for interceptors to handle error occurred during the request.
-
ErrorNotification
-
A notification representing an error event from a Stream.
-
ErrorSink
-
A generic destination for errors.
-
ExhaustMapStreamTransformer<S, T>
-
Converts events from the source stream into a new Stream using a given
mapper. It ignores all items from the source stream until the new stream
completes.
-
FlatBuiltValueToStringHelper
-
A BuiltValueToStringHelper that produces single line output.
-
FlatMapStreamTransformer<S, T>
-
Converts each emitted item into a new Stream using the given mapper function,
while limiting the maximum number of concurrent subscriptions to these Streams.
The newly created Stream will be listened to and begin emitting items downstream.
-
FloatFormatter
-
-
ForkJoinStream<T, R>
-
This operator is best used when you have a group of streams
and only care about the final emitted value of each.
One common use case for this is if you wish to issue multiple
requests on page load (or some other event)
and only want to take action when a response has been received for all.
-
Formatter
-
-
FormData
-
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
-
FromCallableStream<T>
-
Returns a Stream that, when listening to it, calls a function you specify
and then emits the value returned from that function.
-
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
-
GroupByStreamTransformer<T, K>
-
The GroupBy operator divides a Stream that emits items into
a Stream that emits GroupedStream,
each one of which emits some subset of the items
from the original source Stream.
-
GroupedStream<T, K>
-
The Stream used by GroupByStreamTransformer, it contains events
that are grouped by a key value.
-
The headers class for requests and responses.
-
HttpClientAdapter
-
HttpAdapter
is a bridge between Dio and HttpClient.
-
IgnoreElementsStreamTransformer<S>
-
Creates a Stream where all emitted items are ignored, only the
error / completed notifications are passed
-
IndentingBuiltValueToStringHelper
-
A BuiltValueToStringHelper that produces multi-line indented output.
-
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 Interceptors.
-
InterceptorsWrapper
-
A helper class to create interceptors in ease.
-
IntervalStreamTransformer<S>
-
Creates a Stream that emits each item in the Stream after a given
duration.
-
IntFormatter
-
-
Intl
-
The Intl class provides a common entry point for internationalization
related tasks. An Intl instance can be created for a particular locale
and used to create a date format via
anIntl.date()
. Static methods
on this class are also used in message formatting.
-
IosDeviceInfo
-
Information derived from
UIDevice
.
-
IosUtsname
-
Information derived from
utsname
.
See http://pubs.opengroup.org/onlinepubs/7908799/xsh/sysutsname.h.html for details.
-
KiwiContainer
-
A simple service container.
-
LinuxDeviceInfo
-
Device information for a Linux system.
-
ListBuilder<E>
-
The Built Collection builder for BuiltList.
-
ListMultimapBuilder<K, V>
-
The Built Collection builder for BuiltListMultimap.
-
ListParam<T>
-
Indicates a param being used as queries or form data,
and how does it gets formatted.
-
Localization
-
-
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.
-
MacOsDeviceInfo
-
Object encapsulating MACOS device information.
-
MapBuilder<K, V>
-
The Built Collection builder for BuiltMap.
-
MapNotNullStreamTransformer<T, R extends Object>
-
Create a Stream containing only the non-
null
results
of applying the given transform function to each element of the Stream.
-
MapToStreamTransformer<S, T>
-
Emits the given constant value on the output Stream every time the source
Stream emits a value.
-
MaterializeStreamTransformer<S>
-
Converts the onData, on Done, and onError events into StreamNotification
objects that are passed into the downstream onData listener.
-
MergeStream<T>
-
Flattens the items emitted by the given streams into a single Stream
sequence.
-
MicroMoney
-
Used primarily for currency formatting, this number-like class stores
millionths of a currency unit, typically as an Int64.
-
MultiBlocListener
-
Merges multiple BlocListener widgets into one widget tree.
-
MultiBlocProvider
-
Merges multiple BlocProvider widgets into one widget tree.
-
MultipartFile
-
An upload content that is a part of
MultipartRequest
.
This doesn't need to correspond to a physical file.
-
MultiRepositoryProvider
-
Merges multiple RepositoryProvider widgets into one widget tree.
-
NeverStream<T>
-
Returns a non-terminating stream sequence, which can be used to denote
an infinite duration.
-
NumberFormat
-
Provides the ability to format a number in a locale-specific way.
-
NumberParserBase<R>
-
-
OnErrorResumeStreamTransformer<S>
-
Intercepts error events and switches to a recovery stream created by the
provided recoveryFn Function.
-
Options
-
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose.
-
PairwiseStreamTransformer<T>
-
Emits the n-th and n-1th events as a pair.
The first event won't be emitted until the second one arrives.
-
PrintFormat
-
-
PublishConnectableStream<T>
-
A ConnectableStream that converts a single-subscription Stream into
a broadcast Stream.
-
PublishSubject<T>
-
Exactly like a normal broadcast StreamController with one exception:
this class is both a Stream and Sink.
-
QueuedInterceptor
-
Interceptor in queue.
-
QueuedInterceptorsWrapper
-
A helper class to create QueuedInterceptor in ease.
-
RaceStream<T>
-
Given two or more source streams, emit all of the items from only
the first of these streams to emit an item or notification.
-
RangeStream
-
Returns a Stream that emits a sequence of Integers within a specified
range.
-
RedirectRecord
-
A record that records the redirection happens during requests,
including status code, request method, and the location.
-
Register
-
An annotation that generates code for registering factories
using the kiwi container.
-
RepeatStream<T>
-
Creates a Stream that will recreate and re-listen to the source
Stream the specified number of times until the Stream terminates
successfully.
-
ReplayConnectableStream<T>
-
A ConnectableStream that converts a single-subscription Stream into
a broadcast Stream that replays emitted items to any new listener, and
provides synchronous access to the list of emitted values.
-
ReplayStream<T>
-
An Stream that provides synchronous access to the emitted values
-
ReplaySubject<T>
-
A special StreamController that captures all of the items that have been
added to the controller, and emits those as the first items to any new
listener.
-
RepositoryProvider<T>
-
Takes a
create
function that is responsible for creating the repository
and a child
which will have access to the repository via
RepositoryProvider.of(context)
.
It is used as a dependency injection (DI) widget so that a single instance
of a repository can be provided to multiple widgets within a subtree.
-
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.
-
RetryStream<T>
-
Creates a Stream that will recreate and re-listen to the source
Stream the specified number of times until the Stream terminates
successfully.
-
RetryWhenStream<T>
-
Creates a Stream that will recreate and re-listen to the source
Stream when the notifier emits a new value. If the source Stream
emits an error or it completes, the Stream terminates.
-
Rx
-
A utility class that provides static methods to create the various Streams
provided by RxDart.
-
SampleStreamTransformer<T>
-
A StreamTransformer that, when the specified window Stream emits
an item or completes, emits the most recently emitted item (if any)
emitted by the source Stream since the previous emission from
the sample Stream.
-
ScanStreamTransformer<S, T>
-
Applies an accumulator function over an stream sequence and returns
each intermediate result. The seed value is used as the initial
accumulator value.
-
SequenceEqualStream<S, T>
-
Determine whether two Streams emit the same sequence of items.
You can provide an optional equals handler to determine equality.
-
SetBuilder<E>
-
The Built Collection builder for BuiltSet.
-
SetMultimapBuilder<K, V>
-
The Built Collection builder for BuiltSetMultimap.
-
SkipLastStreamTransformer<T>
-
Skip the last count items emitted by the source Stream
-
SkipUntilStreamTransformer<S, T>
-
Starts emitting events only after the given stream emits an event.
-
StartWithManyStreamTransformer<S>
-
Prepends a sequence of values to the source Stream.
-
StartWithStreamTransformer<S>
-
Prepends a value to the source Stream.
-
StateStreamable<State>
-
A Streamable that provides synchronous access to the current state.
-
StateStreamableSource<State>
-
A StateStreamable that must be closed when no longer in use.
-
Streamable<State extends Object?>
-
An object that provides access to a stream of states over time.
-
StreamNotification<T>
-
A class that encapsulates the NotificationKind of event, value of the event in case of
onData, or the Error in the case of onError.
A container object that wraps the NotificationKind of event (OnData, OnDone, OnError),
and the item or error that was emitted. In the case of onDone, no data is
emitted as part of the StreamNotification.
-
StringFormatter
-
-
Subject<T>
-
The base for all Subjects. If you'd like to create a new Subject,
extend from this class.
-
SwitchIfEmptyStreamTransformer<S>
-
When the original stream emits no items, this operator subscribes to
the given fallback stream and emits items from that stream instead.
-
SwitchLatestStream<T>
-
Convert a Stream that emits Streams (aka a 'Higher Order Stream') into a
single Stream that emits the items emitted by the most-recently-emitted of
those Streams.
-
SwitchMapStreamTransformer<S, T>
-
Converts each emitted item into a new Stream using the given mapper
function. The newly created Stream will be be listened to and begin
emitting items, and any previously created Stream will stop emitting.
-
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.
-
TakeLastStreamTransformer<T>
-
Emits only the final count values emitted by the source Stream.
-
TakeUntilStreamTransformer<S, T>
-
Returns the values from the source stream sequence until the other
stream sequence produces a value.
-
TakeWhileInclusiveStreamTransformer<S>
-
Emits values emitted by the source Stream so long as each value
satisfies the given test. When the test is not satisfied by a value, it
will emit this value as a final event and then complete.
-
TextDirection
-
Represents directionality of text.
-
ThrottleStreamTransformer<T>
-
A StreamTransformer that emits a value from the source Stream,
then ignores subsequent source values while the window Stream is open,
then repeats this process.
-
TimeInterval<T>
-
A class that represents a snapshot of the current value emitted by a
Stream, at a specified interval.
-
TimeIntervalStreamTransformer<S>
-
Records the time interval between consecutive values in an stream
sequence.
-
TimerStream<T>
-
Emits the given value after a specified amount of time.
-
Timestamped<T>
-
A class that represents a snapshot of the current value emitted by a
Stream, at a specified timestamp.
-
TimestampStreamTransformer<S>
-
Wraps each item emitted by the source Stream in a Timestamped object
that includes the emitted item and the time when the item was emitted.
-
Transformer
-
Transformer allows changes to the request/response data before
it is sent/received to/from the server.
-
Transition<Event, State>
-
A Transition is the change from one state to another.
Consists of the currentState, an event, and the nextState.
-
UsingStream<T, R>
-
When listener listens to it, creates a resource object from resource factory function,
and creates a Stream from the given factory function and resource as argument.
Finally when the stream finishes emitting items or stream subscription
is cancelled (call StreamSubscription.cancel or
Stream.listen(cancelOnError: true)
),
call the disposer function on resource object.
The disposer is called after the future returned from StreamSubscription.cancel completes.
-
ValueConnectableStream<T>
-
A ConnectableStream that converts a single-subscription Stream into
a broadcast Stream that replays the latest value to any new listener, and
provides synchronous access to the latest emitted value.
-
ValueStream<T>
-
A Stream that provides synchronous access to the last emitted value (aka. data event).
-
WebBrowserInfo
-
Information derived from
navigator
.
-
WhereNotNullStreamTransformer<T extends Object>
-
Create a Stream which emits all the non-
null
elements of the Stream,
in their original emission order.
-
WhereTypeStreamTransformer<S, T>
-
This transformer is a shorthand for Stream.where followed by Stream.cast.
-
WindowCountStreamTransformer<T>
-
Buffers a number of values from the source Stream by count then emits the
buffer as a Stream and clears it, and starts a new buffer each
startBufferEvery values. If startBufferEvery is not provided, then new
buffers are started immediately at the start of the source and when each
buffer closes and is emitted.
-
WindowsDeviceInfo
-
Object encapsulating WINDOWS device information.
-
WindowStreamTransformer<T>
-
Creates a Stream where each item is a Stream containing the items
from the source sequence.
-
WindowTestStreamTransformer<T>
-
Creates a Stream where each item is a Stream containing the items
from the source sequence, batched whenever test passes.
-
WithLatestFromStreamTransformer<S, T, R>
-
A StreamTransformer that emits when the source stream emits, combining
the latest values from the two streams using the provided function.
-
ZipStream<T, R>
-
Merges the specified streams into one stream sequence using the given
zipper Function whenever all of the stream sequences have produced
an element at a corresponding index.
Enums
-
BrowserName
-
List of supported browsers
-
ConnectivityResult
-
Connection status check result.
-
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.
-
NotificationKind
-
The type of event used in StreamNotification
-
ResponseType
-
Indicates which transformation should be applied to the response data.
Extensions
-
AddToCompositeSubscriptionExtension
on StreamSubscription<T>
-
Extends the StreamSubscription class with the ability to be added to CompositeSubscription container.
-
BufferExtensions
on Stream<T>
-
Extends the Stream class with the ability to buffer events in various ways
-
BuiltListExtension
on List<T>
-
Extensions for BuiltList on List.
-
BuiltListIterableExtension
on Iterable<E>
-
Extensions for BuiltList on Iterable.
-
BuiltMapExtension
on Map<K, V>
-
Extensions for BuiltMap on Map.
-
BuiltSetExtension
on Set<T>
-
Extensions for BuiltSet on Set.
-
BuiltSetIterableExtension
on Iterable<E>
-
Extensions for BuiltSet on Iterable.
-
ConcatExtensions
on Stream<T>
-
Extends the Stream class with the ability to concatenate one stream with
another.
-
ConnectableStreamExtensions
on Stream<T>
-
Extends the Stream class with the ability to transform a single-subscription
Stream into a ConnectableStream.
-
contextExtension
on BuildContext
-
-
DebounceExtensions
on Stream<T>
-
Extends the Stream class with the ability to debounce events in various ways
-
DefaultIfEmptyExtension
on Stream<T>
-
-
DelayExtension
on Stream<T>
-
Extends the Stream class with the ability to delay events being emitted
-
DelayWhenExtension
on Stream<T>
-
Extends the Stream class with the ability to delay events being emitted.
-
DematerializeExtension
on Stream<StreamNotification<T>>
-
Converts the onData, onDone, and onError StreamNotifications from a
materialized stream into normal onData, onDone, and onError events.
-
DistinctUniqueExtension
on Stream<T>
-
Extends the Stream class with the ability to skip items that have previously
been emitted.
-
DoExtensions
on Stream<T>
-
Extends the Stream class with the ability to execute a callback function
at different points in the Stream's lifecycle.
-
EndWithExtension
on Stream<T>
-
Extends the Stream class with the ability to emit the given value as the
final item before closing.
-
EndWithManyExtension
on Stream<T>
-
Extends the Stream class with the ability to emit the given value as the
final item before closing.
-
ErrorAndStackTracesReplayStreamExtension
on ReplayStream<T>
-
Extension method on ReplayStream to access the emitted ErrorAndStackTraces.
-
ErrorAndStackTraceValueStreamExtension
on ValueStream<T>
-
Extension method on ValueStream to access the last emitted ErrorAndStackTrace.
-
ExhaustMapExtension
on Stream<T>
-
Extends the Stream class with the ability to transform the Stream into
a new Stream. The new Stream emits items and ignores events from the source
Stream until the new Stream completes.
-
FlatMapExtension
on Stream<T>
-
Extends the Stream class with the ability to convert the source Stream into
a new Stream each time the source emits an item.
-
GroupByExtension
on Stream<T>
-
Extends the Stream class with the ability to convert events into Streams
of events that are united by a key.
-
IgnoreElementsExtension
on Stream<T>
-
Extends the Stream class with the ability to skip, or ignore, data events.
-
IntervalExtension
on Stream<T>
-
Extends the Stream class with the ability to emit each item after a given
duration.
-
LastEventValueStreamExtensions
on ValueStream<T>
-
Extension methods on ValueStream related to lastEventOrNull.
-
localizationList
on List<Localization>
-
-
MapNotNullExtension
on Stream<T>
-
Extends the Stream class with the ability to convert the source Stream
to a Stream containing only the non-
null
results
of applying the given transform function to each element of this Stream.
-
MapToExtension
on Stream<S>
-
Extends the Stream class with the ability to convert each item to the same
value.
-
MaterializeExtension
on Stream<T>
-
Extends the Stream class with the ability to convert the onData, on Done,
and onError events into StreamNotifications that are passed into the
downstream onData listener.
-
MaxExtension
on Stream<T>
-
Extends the Stream class with the ability to transform into a Future
that completes with the largest item emitted by the Stream.
-
MergeExtension
on Stream<T>
-
Extends the Stream class with the ability to merge one stream with another.
-
MinExtension
on Stream<T>
-
Extends the Stream class with the ability to transform into a Future
that completes with the smallest item emitted by the Stream.
-
OnErrorExtensions
on Stream<T>
-
Extends the Stream class with the ability to recover from errors in various
ways
-
PairwiseExtension
on Stream<T>
-
Extends the Stream class with the ability to emit the nth and n-1th events
as a pair
-
ReadContext
on BuildContext
-
Exposes the read method.
-
SampleExtensions
on Stream<T>
-
Extends the Stream class with the ability to sample events from the Stream
-
ScanExtension
on Stream<T>
-
Extends
-
SelectContext
on BuildContext
-
Adds a
select
method on BuildContext.
-
SkipLastExtension
on Stream<T>
-
Extends the Stream class with the ability to skip the last
count
items
emitted by the source Stream
-
SkipUntilExtension
on Stream<T>
-
Extends the Stream class with the ability to skip events until another
Stream emits an item.
-
StartWithExtension
on Stream<T>
-
Extends the Stream class with the ability to emit the given value as the
first item.
-
StartWithManyExtension
on Stream<T>
-
Extends the Stream class with the ability to emit the given values as the
first items.
-
StreamNotificationExtensions
on StreamNotification<T>
-
Provides extension methods on StreamNotification.
-
SwitchIfEmptyExtension
on Stream<T>
-
Extend the Stream class with the ability to return an alternative Stream
if the initial Stream completes with no items.
-
SwitchMapExtension
on Stream<T>
-
Extends the Stream with the ability to convert one stream into a new Stream
whenever the source emits an item. Every time a new Stream is created, the
previous Stream is discarded.
-
TakeLastExtension
on Stream<T>
-
Extends the Stream class with the ability receive only the final
count
events from the source Stream.
-
TakeUntilExtension
on Stream<T>
-
Extends the Stream class with the ability receive events from the source
Stream until another Stream produces a value.
-
TakeWhileInclusiveExtension
on Stream<T>
-
Extends the Stream class with the ability to take events while they pass
the condition given and include last event that doesn't pass the condition.
-
ThrottleExtensions
on Stream<T>
-
Extends the Stream class with the ability to throttle events in various ways
-
TimeIntervalExtension
on Stream<T>
-
Extends the Stream class with the ability to record the time interval
between consecutive values in an stream
-
TimeStampExtension
on Stream<T>
-
Extends the Stream class with the ability to wrap each item emitted by the
source Stream in a Timestamped object that includes the emitted item and
the time when the item was emitted.
-
WatchContext
on BuildContext
-
Exposes the watch method.
-
WhereNotNullExtension
on Stream<T?>
-
Extends the Stream class with the ability to convert the source Stream
to a Stream which emits all the non-
null
elements
of this Stream, in their original emission order.
-
WhereTypeExtension
on Stream<T>
-
Extends the Stream class with the ability to filter down events to only
those of a specific type.
-
WindowExtensions
on Stream<T>
-
Extends the Stream class with the ability to window
-
WithLatestFromExtensions
on Stream<T>
-
Extends the Stream class with the ability to merge the source Stream with
the last emitted item from another Stream.
-
ZipWithExtension
on Stream<T>
-
Extends the Stream class with the ability to zip one Stream with another.
Constants
-
memoized
→ const String
-
Memoized annotation for Built Value getters.
-
nullable
→ const String
-
Annotation that was used to mark nullable Built Value fields.
Typedefs
-
BlocBuilderCondition<S>
= bool Function(S previous, S current)
-
Signature for the
buildWhen
function which takes the previous state
and
the current state
and is responsible for returning a bool which
determines whether to rebuild BlocBuilder with the current state
.
-
BlocListenerCondition<S>
= bool Function(S previous, S current)
-
Signature for the
listenWhen
function which takes the previous state
and the current state
and is responsible for returning a bool which
determines whether or not to call BlocWidgetListener of BlocListener
with the current state
.
-
BlocWidgetBuilder<S>
= Widget Function(BuildContext context, S state)
-
Signature for the
builder
function which takes the BuildContext
and
state
and is responsible for returning a widget which is to be rendered.
This is analogous to the builder
function in StreamBuilder.
-
BlocWidgetListener<S>
= void Function(BuildContext context, S state)
-
Signature for the
listener
function which takes the BuildContext
along
with the state
and is responsible for executing in response to
state
changes.
-
BlocWidgetSelector<S, T>
= T Function(S state)
-
Signature for the
selector
function which
is responsible for returning a selected value, T
, based on state
.
-
BuiltValueToStringHelperProvider
= BuiltValueToStringHelper Function(String className)
-
Function that returns a BuiltValueToStringHelper.
-
DefaultTransformer
= SyncTransformer
-
-
DioError
= DioException
-
DioError describes the exception info when a request failed.
-
DioErrorType
= DioExceptionType
-
Deprecated in favor of DioExceptionType and will be removed in future major versions.
-
DioExceptionReadableStringBuilder
= String Function(DioException e)
-
The readable string builder's signature of
DioException.readableStringBuilder.
-
DioMediaType
= MediaType
-
The type (alias) for specifying the content-type of the
MultipartFile
.
-
EventHandler<Event, State>
= FutureOr<void> Function(Event event, Emitter<State> emit)
-
An event handler is responsible for reacting to an incoming
Event
and can emit zero or more states via the Emitter.
-
EventMapper<Event>
= Stream<Event> Function(Event event)
-
Signature for a function which converts an incoming event
into an outbound stream of events.
Used when defining custom EventTransformers.
-
EventTransformer<Event>
= Stream<Event> Function(Stream<Event> events, EventMapper<Event> mapper)
-
Used to change how events are processed.
By default events are processed concurrently.
-
FactoryBuilder<T>
= T Function(KiwiContainer container)
-
Signature for a builder which creates an object of type
T
.
-
The signature that iterates header fields.
-
InterceptorErrorCallback
= void Function(DioException error, ErrorInterceptorHandler handler)
-
The signature of Interceptor.onError.
-
InterceptorSendCallback
= void Function(RequestOptions options, RequestInterceptorHandler handler)
-
The signature of Interceptor.onRequest.
-
InterceptorSuccessCallback
= void Function(Response response, ResponseInterceptorHandler handler)
-
The signature of Interceptor.onResponse.
-
JsonDecodeCallback
= FutureOr Function(String)
-
The callback definition for decoding a JSON string.
-
JsonEncodeCallback
= FutureOr<String> Function(Object)
-
The callback definition for encoding a JSON object.
-
NetworkManagerClientFactory
= NetworkManagerClient Function()
-
-
PrintFormatFormatter
= Formatter Function(dynamic arg, dynamic options)
-
-
ProgressCallback
= void Function(int count, int total)
-
The type of a progress listening callback when sending or receiving data.
-
RequestEncoder
= FutureOr<List<int>> Function(String request, RequestOptions options)
-
The type of a request encoding callback.
-
ResponseDecoder
= FutureOr<String?> Function(List<int> responseBytes, RequestOptions options, ResponseBody responseBody)
-
The type of a response decoding callback.
-
ValidateStatus
= bool Function(int? status)
-
The type of a response status code validate callback.