_common library

Classes

AnsiStyle
A class that provides a way to style strings with ANSI escape codes.
AsciiCodec
An AsciiCodec allows encoding strings as ASCII bytes and decoding ASCII bytes to strings.
AsciiDecoder
Converts ASCII bytes to string.
AsciiEncoder
Converts strings of only ASCII characters to bytes.
Async<T extends Object>
A Monad that represents a Resolvable that holds an asynchronous Result.
AsyncPodBuilder<T extends Object>
AuthInterface
AutoTranslationController<TRemoteDatabaseInterface extends DatabaseInterface, TCachedDatabaseInterface extends DatabaseInterface, TTranslationInterface extends TranslatorInterface<Object>>
AutoTranslationScope
Base64Codec
A base64 encoder and decoder.
Base64Decoder
Decoder for base64 encoded data.
Base64Encoder
Base64 and base64url encoding converter.
BaseClient
The abstract base class for an HTTP client.
BaseRequest
The base class for HTTP requests.
BaseResponse
The base class for HTTP responses.
BaseResponseWithUrl
A BaseResponse with a url field.
BuilderSnapshot
ByteConversionSink
The ByteConversionSink provides an interface for converters to efficiently transmit byte data.
ByteStream
A stream of chunks of bytes representing a single piece of data.
ChildPod<TParent extends Object, TChild extends Object>
ChunkedConversionSink<T>
A ChunkedConversionSink is used to transmit data more efficiently between two converters during chunked conversions.
ClaudeContent
ClaudeTranslatorBroker
Client
The interface for HTTP clients that take care of maintaining persistent connections across multiple requests to the same server.
ClosableStringSink
A ClosableStringSink extends the StringSink interface by adding a close method.
Codec<S, T>
A Codec encodes and (if supported) decodes data.
Completer<T>
A way to produce Future objects and to complete them later with a value or error.
Config<TConfigRef extends ConfigRef>
A configuration class, used to map strings to values.
ConfigFileRef
A reference to a config file.
ConfigManager<TConfig extends Config<ConfigRef>>
ConfigRef<TRef, TType>
A reference to a config element.
Converter<S, T>
A Converter converts data from one representation into another.
DatabaseInterface
DisposablePod<T extends Object>
Encoding
Open-ended set of encodings.
ErrModel
Generated class for _ErrModel.
EventSink<T>
A Sink that supports adding errors.
FileConfig
FileConfigManager
FirebaseAuthBroker
FirestoreDatabseBroker
ForcedAsyncPodListBuilder<T extends Object>
Future<T>
The result of an asynchronous computation.
FutureOr<T>
A type representing values that are either Future<T> or T.
GemeniContent
GeminiTranslatorBroker
GoogleTranslatorBroker
Here
A utility class for capturing the current code location (file, line, column, member).
HtmlEscape
Converter which escapes characters with special meaning in HTML.
HtmlEscapeMode
HTML escape modes.
JsonCodec
A JsonCodec encodes JSON objects to strings and decodes strings to JSON objects.
JsonDecoder
This class parses JSON strings and builds the corresponding objects.
JsonEncoder
This class converts JSON objects to strings.
JsonUtf8Encoder
Encoder that encodes a single object as a UTF-8 encoded JSON string.
Latin1Codec
A Latin1Codec encodes strings to ISO Latin-1 (aka ISO-8859-1) bytes and decodes Latin-1 bytes to strings.
Latin1Decoder
This class converts Latin-1 bytes (lists of unsigned 8-bit integers) to a string.
Latin1Encoder
This class converts strings of only ISO Latin-1 characters to bytes.
Lazy<T extends Object>
A class that provides lazy initialization for instances of type T.
LineSplitter
A StreamTransformer that splits a String into individual lines.
Log
LoginResult
LogItem
Monad<T extends Object>
The foundational sealed class for all monadic types like Option, Result, and Resolvable.
MultipartFile
A file to be uploaded as part of a MultipartRequest.
MultipartRequest
A multipart/form-data request.
MultiplePodReducer
A final class to handle reducing operations for many Pods.
MultiStreamController<T>
An enhanced stream controller provided by Stream.multi.
None<T extends Object>
A Monad that represents an Option that does not contain a value.
Ok<T extends Object>
A Monad that represents the success case of a Result, containing a value.
OnOptionListSnapshot<T extends Object>
OnOptionSnapshot<T extends Object>
OpenAIContent
OpenAITranslatorBroker
Option<T extends Object>
A Monad that represents an optional value: every Option is either Some and contains a value, or None and does not.
PatternSettings
PersistentDatabaseBroker
PodBuilder<T extends Object>
PodBuilderCacheManager
PodBuilderSnapshot<T extends Object>
PodListBuilder<T extends Object>
PodListBuilderSnapshot<T extends Object>
PodNotifier<T extends Object>
An enhanced alternative to ValueNotifier that provides additional lifecycle management capabilities through the ValueListenable.
PodReducer1
A class to handle reducing operations for 1 Pod.
PodReducer2
A class to handle reducing operations for 2 Pods.
PodReducer3
A class to handle reducing operations for 3 Pods.
PodReducer4
A class to handle reducing operations for 4 Pods.
PodReducer5
A class to handle reducing operations for 5 Pods.
PodReducer6
A class to handle reducing operations for 6 Pods.
PodReducer7
A class to handle reducing operations for 7 Pods.
PodResultBuilder<T extends Object>
PodResultBuilderState<T extends Object>
PodResultListBuilder<T extends Object>
PodResultListBuilderState<T extends Object>
PollingPodBuilder<T extends Object>
PrimaryPatternSettings
ProtectedPod<T extends Object>
A RootPod that protects addStrongRefListener and dispose, hiding these methods from external access to prevent misuse or unintended behavior.
ReducerPod<T extends Object>
A Pod that listens to changes to existing Pods returned by the responder. When any of these returned Pods update, it recalculates its value using the reducer function, then calls the responder again to refresh Pods to listen to. This recursive behaviour ensures that the Pod continuously listens to new changes from any updated Pods.
Request
An HTTP request where the entire request body is known in advance.
Resolvable<T extends Object>
A Monad that represents a value which can be resolved either synchronously Sync or asynchronously Async.
ResolvablePodBuilder<T extends Object>
ResolvablePodListBuilder<T extends Object>
ResolvablePollingPodBuilder<T extends Object>
Response
An HTTP response where the entire response body is known in advance.
Result<T extends Object>
A Monad that represents the result of an operation: every Result is either Ok and contains a success value, or Err and contains an error value.
RootPod<T extends Object>
A Pod that serves as the root of a Pod parent-child chain.
SafeCompleter<T extends Object>
SafeSequencer<T extends Object>
A queue that manages the execution of functions sequentially, allowing for optional throttling.
SafeSequencerCallbacks<T extends Object, TParam extends Object>
SecondaryPatternSettings
SharedBoolPodCreator
SharedDoublePodCreator
SharedEnumPodCreator
SharedIntPodCreator
SharedJsonPodCreator
SharedPod<A extends Object, B extends Object>
SharedProtectedPod<A extends Object, B extends Object>
A SharedPod that protects addStrongRefListener and dispose, hiding these methods from external access to prevent misuse or unintended behavior.
SharedStringListPodCreator
SharedStringPodCreator
Some<T extends Object>
A Monad that represents an Option that contains a value.
Stream<T>
A source of asynchronous data events.
StreamConsumer<S>
Abstract interface for a "sink" accepting multiple entire streams.
StreamController<T>
A controller with the stream it controls.
StreamedRequest
An HTTP request where the request body is sent asynchronously after the connection has been established and the headers have been sent.
StreamedResponse
An HTTP response where the response body is received asynchronously after the headers have been received.
StreamIterator<T>
An Iterator-like interface for the values of a Stream.
StreamSink<S>
A object that accepts stream events both synchronously and asynchronously.
StreamSubscription<T>
A subscription on events from a Stream.
StreamTransformer<S, T>
Transforms a Stream.
StreamTransformerBase<S, T>
Base class for implementing StreamTransformer.
StreamView<T>
Stream wrapper that only exposes the Stream interface.
StringConversionSink
A sink for converters to efficiently transmit String data.
Sync<T extends Object>
A Monad that represents a Resolvable that holds a synchronous Result.
SynchronousStreamController<T>
A stream controller that delivers its events synchronously.
SyncPodBuilder<T extends Object>
SyncPodListBuilder<T extends Object>
Timer
A countdown timer that can be configured to fire once or repeatedly.
TranslatedText
A model class that represents a translated text.
TranslationController
TranslationFileReader
Provides a way to easily read translation files.
TranslationManager
TranslatorInterface<T extends Object>
Unit
A type representing a "no value" unit, similar to void but usable in generics.
Utf8Codec
A Utf8Codec encodes strings to utf-8 code units (bytes) and decodes UTF-8 code units to strings.
Utf8Decoder
This class converts UTF-8 code units (lists of unsigned 8-bit integers) to a string.
Utf8Encoder
This class converts strings to their UTF-8 code units (a list of unsigned 8-bit integers).
ValueListenable<T>
An interface for subclasses of Listenable that expose a value.
WeakChangeNotifier
A class that can be extended or mixed in that provides a change notification API using VoidCallback for notifications. It is a modified version of Flutter's ChangeNotifier that uses WeakReference for its listeners.
Zone
A zone represents an environment that remains stable across asynchronous calls.
ZoneDelegate
An adapted view of the parent zone.
ZoneSpecification
A parameter object with custom zone function handlers for Zone.fork.

Enums

ConfigFileType
The supported config file types.

Mixins

GenericPodMixin<T extends Object>
A mixin for managing RootPod and ChildPod.

Extensions

AsyncNoneSwapX on Async<None<T>>
AsyncOkSwapX on Async<Ok<T>>
AsyncSomeSwapX on Async<Some<T>>
CfOnStringX on String
ErrAsyncSwapX on Err<Async<T>>
ErrNoneSwapX on Err<None<T>>
ErrOkSwapX on Err<Ok<T>>
ErrOptionSwapX on Err<Option<T>>
ErrResolvableSwapX on Err<Resolvable<T>>
ErrResultSwapX on Err<Result<T>>
ErrSomeSwapX on Err<Some<T>>
ErrSyncSwapX on Err<Sync<T>>
FlattenOption2 on Option<Option<T>>
FlattenOption3 on Option<Option<Option<T>>>
FlattenOption4 on Option<Option<Option<Option<T>>>>
FlattenOption5 on Option<Option<Option<Option<Option<T>>>>>
FlattenOption6 on Option<Option<Option<Option<Option<Option<T>>>>>>
FlattenOption7 on Option<Option<Option<Option<Option<Option<Option<T>>>>>>>
FlattenOption8 on Option<Option<Option<Option<Option<Option<Option<Option<T>>>>>>>>
FlattenOption9 on Option<Option<Option<Option<Option<Option<Option<Option<Option<T>>>>>>>>>
FlattenResolvable2 on Resolvable<Resolvable<T>>
FlattenResolvable3 on Resolvable<Resolvable<Resolvable<T>>>
FlattenResolvable4 on Resolvable<Resolvable<Resolvable<Resolvable<T>>>>
FlattenResolvable5 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>
FlattenResolvable6 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>>
FlattenResolvable7 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>>>
FlattenResolvable8 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>>>>
FlattenResolvable9 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>>>>>
FlattenResolvableResult2 on Resolvable<Result<T>>
FlattenResolvableResulte3 on Resolvable<Result<Result<T>>>
FlattenResolvableResulte4 on Resolvable<Result<Result<Result<T>>>>
FlattenResolvableResulte5 on Resolvable<Result<Result<Result<Result<T>>>>>
FlattenResolvableResulte6 on Resolvable<Result<Result<Result<Result<Result<T>>>>>>
FlattenResolvableResulte7 on Resolvable<Result<Result<Result<Result<Result<Result<T>>>>>>>
FlattenResolvableResulte8 on Resolvable<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>
FlattenResolvableResulte9 on Resolvable<Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>>
FlattenResult2 on Result<Result<T>>
FlattenResult3 on Result<Result<Result<T>>>
FlattenResult4 on Result<Result<Result<Result<T>>>>
FlattenResult5 on Result<Result<Result<Result<Result<T>>>>>
FlattenResult6 on Result<Result<Result<Result<Result<Result<T>>>>>>
FlattenResult7 on Result<Result<Result<Result<Result<Result<Result<T>>>>>>>
FlattenResult8 on Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>
FlattenResult9 on Result<Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>>
FutureExtensions on Future<T>
Convenience methods on futures.
FutureIterable on Iterable<Future<T>>
FutureIterableOkExtension on Future<Iterable<Ok<T>>>
FutureIterableSomeExtension on Future<Iterable<Some<T>>>
FutureRecord2 on (Future<T1>, Future<T2>)
Parallel operations on a record of futures.
FutureRecord3 on (Future<T1>, Future<T2>, Future<T3>)
Parallel operations on a record of futures.
FutureRecord4 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>)
Parallel operations on a record of futures.
FutureRecord5 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>)
Parallel operations on a record of futures.
FutureRecord6 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>)
Parallel operations on a record of futures.
FutureRecord7 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>)
Parallel operations on a record of futures.
FutureRecord8 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>, Future<T8>)
Parallel operations on a record of futures.
FutureRecord9 on (Future<T1>, Future<T2>, Future<T3>, Future<T4>, Future<T5>, Future<T6>, Future<T7>, Future<T8>, Future<T9>)
Parallel operations on a record of futures.
HeadersWithSplitValues on BaseResponse
IterableAsyncExtension on Iterable<Async<T>>
IterableFutureOptionExtension on Iterable<Future<Option<T>>>
IterableFutureResultExtension on Iterable<Future<Result<T>>>
IterableOkExtension on Iterable<Ok<T>>
IterableOptionExtension on Iterable<Option<T>>
IterableResolvableExtension on Iterable<Resolvable<T>>
IterableResultExtension on Iterable<Result<T>>
IterableSomeExtension on Iterable<Some<T>>
IterableSyncExtension on Iterable<Sync<T>>
MapMonad10 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>>
MapMonad11 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>>>
MapMonad12 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>>>>
MapMonad13 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>>>>>
MapMonad14 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>>>>>>
MapMonad15 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>>>>>>>
MapMonad16 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>>>>>>>>
MapMonad17 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>>>>>>>>>
MapMonad18 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>>>>>>>>>>
MapMonad2 on Monad<Monad<Object>>
MapMonad3 on Monad<Monad<Monad<Object>>>
MapMonad4 on Monad<Monad<Monad<Monad<Object>>>>
MapMonad5 on Monad<Monad<Monad<Monad<Monad<Object>>>>>
MapMonad6 on Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>
MapMonad7 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>
MapMonad8 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>
MapMonad9 on Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Monad<Object>>>>>>>>>
NoneAsyncSwapX on None<Async<T>>
NoneErrSwapX on None<Err<T>>
NoneOkSwapX on None<Ok<T>>
NoneOptionSwapX on None<Option<T>>
NoneResolvableSwapX on None<Resolvable<T>>
NoneResultSwapX on None<Result<T>>
NoneSomeSwapX on None<Some<T>>
NoneSyncSwapX on None<Sync<T>>
OkAsyncSwapX on Ok<Async<T>>
OkErrSwapX on Ok<Err<T>>
OkNoneSwapX on Ok<None<T>>
OkOptionSwapX on Ok<Option<T>>
OkResolvableSwapX on Ok<Resolvable<T>>
OkResultSwapX on Ok<Result<T>>
OkSomeSwapX on Ok<Some<T>>
OkSyncSwapX on Ok<Sync<T>>
OptionAsyncSwapX on Option<Async<T>>
OptionErrSwapX on Option<Err<T>>
OptionNoneSwapX on Option<None<T>>
OptionOkSwapX on Option<Ok<T>>
OptionResolvableSwapX on Option<Resolvable<T>>
OptionResultSwapX on Option<Result<T>>
OptionSomeSwapX on Option<Some<T>>
OptionSyncSwapX on Option<Sync<T>>
ResolvableNoneSwapX on Resolvable<None<T>>
ResolvableOkSwapX on Resolvable<Ok<T>>
ResolvableSomeSwapX on Resolvable<Some<T>>
ResultAsyncSwapX on Result<Async<T>>
ResultErrSwapX on Result<Err<T>>
ResultNoneSwapX on Result<None<T>>
ResultOkSwapX on Result<Ok<T>>
ResultOptionSwapX on Result<Option<T>>
ResultResolvableSwapX on Result<Resolvable<T>>
ResultSomeSwapX on Result<Some<T>>
ResultSyncSwapX on Result<Sync<T>>
SaferIterable on Iterable<E>
SaferList on List<E>
SaferMap1 on Map<K, V>
SaferMap2 on Map<K, V>
SaferQueue on Queue<E>
SaferSet on Set<E>
SaferString on String
SomeAsyncSwapX on Some<Async<T>>
SomeErrSwapX on Some<Err<T>>
SomeNoneSwapX on Some<None<T>>
SomeOkSwapX on Some<Ok<T>>
SomeOptionSwapX on Some<Option<T>>
SomeResolvableSwapX on Some<Resolvable<T>>
SomeResultSwapX on Some<Result<T>>
SomeSyncSwapX on Some<Sync<T>>
SyncAsyncSwapX on Sync<Async<T>>
SyncErrSwapX on Sync<Err<T>>
SyncNoneSwapX on Sync<None<T>>
SyncOkSwapX on Sync<Ok<T>>
SyncOptionSwapX on Sync<Option<T>>
SyncResolvableSwapX on Sync<Resolvable<T>>
SyncResultSwapX on Sync<Result<T>>
SyncSomeSwapX on Sync<Some<T>>
ToAsyncExtension on Future<T>
ToResolvableExtension on FutureOr<T>
ToSafeStreamExtension on Stream<T>
An extension on Stream to provide a safe way to handle stream events.
ToSync on T
ToUnitOnObjectAsync on Async<Object>
ToUnitOnObjectErr on Err<Object>
ToUnitOnObjectMonad on Monad<Object>
ToUnitOnObjectNone on None<Object>
ToUnitOnObjectOk on Ok<Object>
ToUnitOnObjectOption on Option<Object>
ToUnitOnObjectResolvable on Resolvable<Object>
ToUnitOnObjectResult on Result<Object>
ToUnitOnObjectSome on Some<Object>
ToUnitOnObjectSync on Sync<Object>
ToUnitOnVoidAsync on Async<void>
ToUnitOnVoidErr on Err<void>
ToUnitOnVoidMonad on Monad<void>
ToUnitOnVoidNone on None<void>
ToUnitOnVoidOk on Ok<void>
ToUnitOnVoidOption on Option<void>
ToUnitOnVoidResolvable on Resolvable<void>
ToUnitOnVoidResult on Result<void>
ToUnitOnVoidSome on Some<void>
ToUnitOnVoidSync on Sync<void>
TrOnStringX on String
ValueListenableX on ValueListenable<T>
WithAnsiStyleOnStringExtension on String

Constants

ascii → const AsciiCodec
An instance of the default implementation of the AsciiCodec.
base64 → const Base64Codec
A base64 encoder and decoder.
base64Url → const Base64Codec
A base64url encoder and decoder.
htmlEscape → const HtmlEscape
A String converter that converts characters to HTML entities.
json → const JsonCodec
An instance of the default implementation of the JsonCodec.
kIsDartLibraryUI → const bool
A constatnt that can be used to check if your app is running in a Dart only or Flutter environment. It's true if dart.library.ui is defined and false otherwise.
latin1 → const Latin1Codec
An instance of the default implementation of the Latin1Codec.
unicodeBomCharacterRune → const int
The Unicode Byte Order Marker (BOM) character U+FEFF.
unicodeReplacementCharacterRune → const int
The Unicode Replacement character U+FFFD (�).
UNIT → const Unit
utf8 → const Utf8Codec
An instance of the default implementation of the Utf8Codec.

Functions

asyncNone<T extends Object>() → Async<None<T>>
asyncUnit() → Async<Unit>
base64Decode(String source) → Uint8List
Decodes base64 or base64url encoded bytes.
base64Encode(List<int> bytes) → String
Encodes bytes using base64 encoding.
base64UrlEncode(List<int> bytes) → String
Encodes bytes using base64url encoding.
combineAsync<T extends Object>(Iterable<Async<T>> asyncs, {Err<List<T>> onErr(List<Result<T>> allResults)?}) → Async<List<T>>
Combines an iterable of Asyncs into one containing a list of their values.
combineOption<T extends Object>(Iterable<Option<T>> options) → Option<List<T>>
Combines an iterable of Options into one containing a list of their values.
combineResolvable<T extends Object>(Iterable<Resolvable<T>> resolvables, {Err<List<T>> onErr(List<Result<T>> allResults)?}) → Resolvable<List<T>>
Combines an iterable of Resolvables into one containing a list of their values.
combineResult<T extends Object>(Iterable<Result<T>> results, {Err<List<T>> onErr(List<Result<T>> allResults)?}) → Result<List<T>>
Combines an iterable of Results into one containing a list of their values.
combineSync<T extends Object>(Iterable<Sync<T>> syncs, {Err<List<T>> onErr(List<Result<T>> allResults)?}) → Sync<List<T>>
Combines an iterable of Syncs into one containing a list of their values.
convertToFirestoreJson(Map<String, dynamic> localJson) → Map<String, dynamic>
convertToFirestoreValue(dynamic value) → Map<String, dynamic>
convertToLocalJson(Map<String, dynamic> firestoreJson) → Map<String, dynamic>
convertToLocalValue(dynamic value) → dynamic
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP DELETE request with the given headers to the given URL.
get(Uri url, {Map<String, String>? headers}) → Future<Response>
Sends an HTTP GET request with the given headers to the given URL.
getNormalizedLanguageTag(Locale locale) → String
Sends an HTTP HEAD request with the given headers to the given URL.
jsonDecode(String source, {Object? reviver(Object? key, Object? value)?}) → dynamic
Parses the string and returns the resulting Json object.
jsonDecodeOrNone<T extends Object>(String input) → Option<T>
jsonEncode(Object? object, {Object? toEncodable(Object? nonEncodable)?}) → String
Converts object to a JSON string.
letAsOrNone<T extends Object>(dynamic input) → Option<T>
letBoolOrNone(dynamic input) → Option<bool>
letDateTimeOrNone(dynamic input) → Option<DateTime>
letDoubleOrNone(dynamic input) → Option<double>
letIntOrNone(dynamic input) → Option<int>
letIterableOrNone<T extends Object>(dynamic input) → Option<Iterable<T>>
letListOrNone<T extends Object>(dynamic input) → Option<List<T>>
letMapOrNone<K extends Object, V extends Object>(dynamic input) → Option<Map<K, V>>
letNumOrNone(dynamic input) → Option<num>
letQueueOrNone<T extends Object>(dynamic input) → Option<Queue<T>>
letSetOrNone<T extends Object>(dynamic input) → Option<Set<T>>
letUriOrNone(dynamic input) → Option<Uri>
localeFromString(String? localeString) → Locale?
patch(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PATCH request with the given headers and body to the given URL.
post(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP POST request with the given headers and body to the given URL.
put(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PUT request with the given headers and body to the given URL.
read(Uri url, {Map<String, String>? headers}) → Future<String>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
readBytes(Uri url, {Map<String, String>? headers}) → Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
resolvableNone<T extends Object>() → Resolvable<None<T>>
resolvableUnit() → Resolvable<Unit>
runWithClient<R>(R body(), Client clientFactory(), {ZoneSpecification? zoneSpecification}) → R
Runs body in its own Zone with the Client returned by clientFactory set as the default Client.
runZoned<R>(R body(), {Map<Object?, Object?>? zoneValues, ZoneSpecification? zoneSpecification, Function? onError}) → R
Runs body in its own zone.
runZonedGuarded<R>(R body(), void onError(Object error, StackTrace stack), {Map<Object?, Object?>? zoneValues, ZoneSpecification? zoneSpecification}) → R?
Runs body in its own error zone.
scheduleMicrotask(void callback()) → void
Runs a function asynchronously.
syncNone<T extends Object>() → Sync<None<T>>
syncUnit() → Sync<Unit>
unawaited(Future<void>? future) → void
Explicitly ignores a future.
UNSAFE<T>(T block()) → T
Executes a block of code that is considered UNSAFE, allowing the use of methods like unwrap(). This function provides no actual safety guarantees; it only serves as a marker for linter rules and to signal to developers that the contained code can throw exceptions from monad operations.
unwrapOptionOrNull(dynamic input) → dynamic

Typedefs

ByteConversionSinkBase = ByteConversionSink
This class provides a base-class for converters that need to accept byte inputs.
ControllerCallback = void Function()
Type of a stream controller's onListen, onPause and onResume callbacks.
ControllerCancelCallback = FutureOr<void> Function()
Type of stream controller onCancel callbacks.
CreatePeriodicTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration period, void f(Timer timer))
The type of a custom Zone.createPeriodicTimer implementation function.
CreateTimerHandler = Timer Function(Zone self, ZoneDelegate parent, Zone zone, Duration duration, void f())
The type of a custom Zone.createTimer implementation function.
ErrorCallbackHandler = AsyncError? Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace? stackTrace)
The type of a custom Zone.errorCallback implementation function.
ForkHandler = Zone Function(Zone self, ZoneDelegate parent, Zone zone, ZoneSpecification? specification, Map<Object?, Object?>? zoneValues)
The type of a custom Zone.fork implementation function.
GenericPod<T extends Object> = GenericPodMixin<T>
An alias for GenericPod.
Glog = Log
HandleUncaughtErrorHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace stackTrace)
The type of a custom Zone.handleUncaughtError implementation function.
LazyConstructor<T extends Object> = Resolvable<T> Function()
Pod<T extends Object> = RootPod<T>
An alias for Pod.
PrintHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, String line)
The type of a custom Zone.print implementation function.
RegisterBinaryCallbackHandler = ZoneBinaryCallback<R, T1, T2> Function<R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2))
The type of a custom Zone.registerBinaryCallback implementation function.
RegisterCallbackHandler = ZoneCallback<R> Function<R>(Zone self, ZoneDelegate parent, Zone zone, R f())
The type of a custom Zone.registerCallback implementation function.
RegisterUnaryCallbackHandler = ZoneUnaryCallback<R, T> Function<R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg))
The type of a custom Zone.registerUnaryCallback implementation function.
RunBinaryHandler = R Function<R, T1, T2>(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2), T1 arg1, T2 arg2)
The type of a custom Zone.runBinary implementation function.
RunHandler = R Function<R>(Zone self, ZoneDelegate parent, Zone zone, R f())
The type of a custom Zone.run implementation function.
RunUnaryHandler = R Function<R, T>(Zone self, ZoneDelegate parent, Zone zone, R f(T arg), T arg)
The type of a custom Zone.runUnary implementation function.
ScheduleMicrotaskHandler = void Function(Zone self, ZoneDelegate parent, Zone zone, void f())
The type of a custom Zone.scheduleMicrotask implementation function.
StringConversionSinkBase = StringConversionSink
This class provides a base-class for converters that need to accept String inputs.
StringConversionSinkMixin = StringConversionSink
This class provides a mixin for converters that need to accept String inputs.
TFileReaderFunction = Future<String> Function(String filePath)
TGlobalPod<T extends Object> = Resolvable<GenericPod<Option<Result<T>>>>
TNullableReducerFn1<C extends Object, P1 extends Object> = C Function(GenericPod<P1> p1)
TNullableReducerFn2<C extends Object, P1 extends Object, P2 extends Object> = C Function(GenericPod<P1> p1, GenericPod<P2> p2)
TOnBeforeDispose<T> = void Function(T value)?
TOnOptionBuilder<T extends Object, TSnapshot extends OnOptionSnapshot<T>> = Widget Function(BuildContext context, TSnapshot snapshot)
TOnOptionListBuilder<T extends Object, TSnapshot extends OnOptionListSnapshot<T>> = Widget Function(BuildContext context, TSnapshot snapshot)
TOptionResult<T extends Object> = Option<Result<T>>
TPodsResponderFn<T extends Object> = Iterable<GenericPod<T>> Function()
TReduced<T extends Object> = Resolvable<Option<T>>
TReducerFn1<C extends Object, P1 extends Object> = C Function(GenericPod<P1> p1)
TReducerFn2<C extends Object, P1 extends Object, P2 extends Object> = C Function(GenericPod<P1> p1, GenericPod<P2> p2)
TReducerFn3<C extends Object, P1 extends Object, P2 extends Object, P3 extends Object> = C Function(GenericPod<P1> p1, GenericPod<P2> p2, GenericPod<P3> p3)
TReducerFn4<C extends Object, P1 extends Object, P2 extends Object, P3 extends Object, P4 extends Object> = C Function(GenericPod<P1> p1, GenericPod<P2> p2, GenericPod<P3> p3, GenericPod<P4> p4)
TReducerFn5<C extends Object, P1 extends Object, P2 extends Object, P3 extends Object, P4 extends Object, P5 extends Object> = C Function(GenericPod<P1> p1, GenericPod<P2> p2, GenericPod<P3> p3, GenericPod<P4> p4, GenericPod<P5> p5)
TReducerFn6<C extends Object, P1 extends Object, P2 extends Object, P3 extends Object, P4 extends Object, P5 extends Object, P6 extends Object> = C Function(GenericPod<P1> p1, GenericPod<P2> p2, GenericPod<P3> p3, GenericPod<P4> p4, GenericPod<P5> p5, GenericPod<P6> p6)
TReducerFn7<C extends Object, P1 extends Object, P2 extends Object, P3 extends Object, P4 extends Object, P5 extends Object, P6 extends Object, P7 extends Object> = C Function(GenericPod<P1> p1, GenericPod<P2> p2, GenericPod<P3> p3, GenericPod<P4> p4, GenericPod<P5> p5, GenericPod<P6> p6, GenericPod<P7> p7)
TResponderFn1<P1 extends Object> = (GenericPod<P1>) Function()
TResponderFn2<P1 extends Object, P2 extends Object> = (GenericPod<P1>, GenericPod<P2>) Function()
TResponderFn3<P1 extends Object, P2 extends Object, P3 extends Object> = (GenericPod<P1>, GenericPod<P2>, GenericPod<P3>) Function()
TResponderFn4<P1 extends Object, P2 extends Object, P3 extends Object, P4 extends Object> = (GenericPod<P1>, GenericPod<P2>, GenericPod<P3>, GenericPod<P4>) Function()
TResponderFn5<P1 extends Object, P2 extends Object, P3 extends Object, P4 extends Object, P5 extends Object> = (GenericPod<P1>, GenericPod<P2>, GenericPod<P3>, GenericPod<P4>, GenericPod<P5>) Function()
TResponderFn6<P1 extends Object, P2 extends Object, P3 extends Object, P4 extends Object, P5 extends Object, P6 extends Object> = (GenericPod<P1>, GenericPod<P2>, GenericPod<P3>, GenericPod<P4>, GenericPod<P5>, GenericPod<P6>) Function()
TResponderFn7<P1 extends Object, P2 extends Object, P3 extends Object, P4 extends Object, P5 extends Object, P6 extends Object, P7 extends Object> = (GenericPod<P1>, GenericPod<P2>, GenericPod<P3>, GenericPod<P4>, GenericPod<P5>, GenericPod<P6>, GenericPod<P7>) Function()
TSafeCallback<T extends Object, TParam extends Object> = Resolvable<Option<T>> Function(Object callbackKey, TParam param)
TSharedBoolPod = SharedPod<bool, bool>
TSharedDoublePod = SharedPod<double, double>
TSharedEnumPod<T extends Enum> = SharedPod<T, String>
TSharedIntPod = SharedPod<int, int>
TSharedJsonPod = SharedPod<Map<String, Object>, String>
TSharedProtectedBoolPod = SharedProtectedPod<bool, bool>
TSharedProtectedDoublePod = SharedProtectedPod<double, double>
TSharedProtectedEnumPod<T extends Enum> = SharedProtectedPod<T, String>
TSharedProtectedIntPod = SharedProtectedPod<int, int>
TSharedProtectedJsonPod = SharedProtectedPod<Map<String, Object>, String>
TSharedProtectedPod = SharedProtectedPod<String, String>
TSharedProtectedStringListPod = SharedProtectedPod<List<String>, List<String>>
TSharedStringListPod = SharedPod<List<String>, List<String>>
TSharedStringPod = SharedPod<String, String>
TTransaltionMap = Map<String, TranslatedText>
TValuesReducerFn<TChild, TParentList> = TChild Function(List<TParentList> parentValues)
ZoneBinaryCallback<R, T1, T2> = R Function(T1, T2)
ZoneCallback<R> = R Function()
ZoneUnaryCallback<R, T> = R Function(T)

Exceptions / Errors

AsyncError
An error and a stack trace.
ClientException
An exception caused by an error in a pkg/http client.
DeferredLoadException
Thrown when a deferred library fails to load.
Err<T extends Object>
A Monad that represents the failure case of a Result, containing an error value.
JsonCyclicError
Reports that an object could not be stringified due to cyclic references.
JsonUnsupportedObjectError
Error thrown by JSON serialization if an object cannot be serialized.
ParallelWaitError<V, E>
Error thrown when waiting for multiple futures, when some have errors.
TimeoutException
Thrown when a scheduled timeout happens while waiting for an async result.