_common library

Classes

Abortable
An HTTP request that can be aborted before it completes.
AbortableMultipartRequest
A MultipartRequest which supports abortion using abortTrigger.
AbortableRequest
A Request which supports abortion using abortTrigger.
AbortableStreamedRequest
A StreamedRequest which supports abortion using abortTrigger.
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 Outcome that represents a Resolvable that holds an asynchronous Result.
AsyncImpl<T extends Object>
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.
CacheManager<T>
A generic, in-memory cache with optional time-based expiration.
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.
ConcurrentTaskBatch<T extends Object>
A task batch that executes its collection of tasks concurrently.
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
Debouncer
A practical Debouncer for optimizing performance by controlling the frequency of function calls in response to rapid events.
DisposablePod<T extends Object>
Encoding
Open-ended set of encodings.
ErrModel
Generated class for _ErrModel.
FileConfig
FileConfigManager
FirebaseAuthBroker
FirestoreDatabseBroker
ForcedAsyncPodListBuilder<T extends Object>
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.
LoginResult
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.
None<T extends Object>
A Outcome that represents an Option that does not contain a value.
Ok<T extends Object>
A Outcome 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 Outcome that represents an optional value: every Option is either Some and contains a value, or None and does not.
Outcome<T extends Object>
The foundational sealed class for all Outcome types like Option, Result and Resolvable.
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 Outcome 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 Outcome 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>
A wrapper around Dart's Completer that prevents it from being completed more than once.
SecondaryPatternSettings
SequencedTaskBatch<T extends Object>
A batch of tasks designed to be executed sequentially by a TaskSequencer.
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 Outcome that represents an Option that contains a value.
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.
StringConversionSink
A sink for converters to efficiently transmit String data.
Sync<T extends Object>
A Outcome that represents a Resolvable that holds a synchronous Result.
SyncImpl<T extends Object>
SyncPodBuilder<T extends Object>
SyncPodListBuilder<T extends Object>
Task<T extends Object>
A data class representing a single, configured task in a sequence.
TaskBatchBase<T extends Object>
Provides a foundational structure for managing a collection of tasks.
TaskSequencer<T extends Object>
Manages a chain of dependent tasks, ensuring they execute sequentially.
Throttle
Limits the execution rate of a function.
Throttle120Hz
A throttle that limits execution to approximately 120 times per second.
Throttle24Hz
A throttle that limits execution to approximately 24 times per second.
Throttle30Hz
A throttle that limits execution to approximately 30 times per second.
Throttle48Hz
A throttle that limits execution to approximately 48 times per second.
Throttle60Hz
A throttle that limits execution to approximately 60 times per second.
ThrottleImmediate
A throttle that runs immediately and has no cool-down period.
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).
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.

Enums

ConfigFileType
The supported config file types.

Mixins

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

Extensions

AsyncOptionExt on Async<Option<T>>
CfOnStringX on String
FlattenAsyncExt2 on Async<Async<T>>
FlattenAsyncExt3 on Async<Async<Async<T>>>
FlattenAsyncExt4 on Async<Async<Async<Async<T>>>>
FlattenAsyncExt5 on Async<Async<Async<Async<Async<T>>>>>
FlattenAsyncExt6 on Async<Async<Async<Async<Async<Async<T>>>>>>
FlattenAsyncExt7 on Async<Async<Async<Async<Async<Async<Async<T>>>>>>>
FlattenAsyncExt8 on Async<Async<Async<Async<Async<Async<Async<Async<T>>>>>>>>
FlattenAsyncExt9 on Async<Async<Async<Async<Async<Async<Async<Async<Async<T>>>>>>>>>
FlattenErrExt2 on Err<Err<T>>
FlattenErrExt3 on Err<Err<Err<T>>>
FlattenErrExt4 on Err<Err<Err<Err<T>>>>
FlattenErrExt5 on Err<Err<Err<Err<Err<T>>>>>
FlattenErrExt6 on Err<Err<Err<Err<Err<Err<T>>>>>>
FlattenErrExt7 on Err<Err<Err<Err<Err<Err<Err<T>>>>>>>
FlattenErrExt8 on Err<Err<Err<Err<Err<Err<Err<Err<T>>>>>>>>
FlattenErrExt9 on Err<Err<Err<Err<Err<Err<Err<Err<Err<T>>>>>>>>>
FlattenNoneExt2 on None<None<T>>
FlattenNoneExt3 on None<None<None<T>>>
FlattenNoneExt4 on None<None<None<None<T>>>>
FlattenNoneExt5 on None<None<None<None<None<T>>>>>
FlattenNoneExt6 on None<None<None<None<None<None<T>>>>>>
FlattenNoneExt7 on None<None<None<None<None<None<None<T>>>>>>>
FlattenNoneExt8 on None<None<None<None<None<None<None<None<T>>>>>>>>
FlattenNoneExt9 on None<None<None<None<None<None<None<None<None<T>>>>>>>>>
FlattenOkExt2 on Ok<Ok<T>>
FlattenOkExt3 on Ok<Ok<Ok<T>>>
FlattenOkExt4 on Ok<Ok<Ok<Ok<T>>>>
FlattenOkExt5 on Ok<Ok<Ok<Ok<Ok<T>>>>>
FlattenOkExt6 on Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>
FlattenOkExt7 on Ok<Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>>
FlattenOkExt8 on Ok<Ok<Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>>>
FlattenOkExt9 on Ok<Ok<Ok<Ok<Ok<Ok<Ok<Ok<Ok<T>>>>>>>>>
FlattenOptionExt2 on Option<Option<T>>
FlattenOptionExt3 on Option<Option<Option<T>>>
FlattenOptionExt4 on Option<Option<Option<Option<T>>>>
FlattenOptionExt5 on Option<Option<Option<Option<Option<T>>>>>
FlattenOptionExt6 on Option<Option<Option<Option<Option<Option<T>>>>>>
FlattenOptionExt7 on Option<Option<Option<Option<Option<Option<Option<T>>>>>>>
FlattenOptionExt8 on Option<Option<Option<Option<Option<Option<Option<Option<T>>>>>>>>
FlattenOptionExt9 on Option<Option<Option<Option<Option<Option<Option<Option<Option<T>>>>>>>>>
FlattenResolvableExt2 on Resolvable<Resolvable<T>>
FlattenResolvableExt3 on Resolvable<Resolvable<Resolvable<T>>>
FlattenResolvableExt4 on Resolvable<Resolvable<Resolvable<Resolvable<T>>>>
FlattenResolvableExt5 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>
FlattenResolvableExt6 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>>
FlattenResolvableExt7 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>>>
FlattenResolvableExt8 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>>>>
FlattenResolvableExt9 on Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<Resolvable<T>>>>>>>>>
FlattenResolvableResulteExt3 on Resolvable<Result<Result<T>>>
FlattenResolvableResulteExt4 on Resolvable<Result<Result<Result<T>>>>
FlattenResolvableResulteExt5 on Resolvable<Result<Result<Result<Result<T>>>>>
FlattenResolvableResulteExt6 on Resolvable<Result<Result<Result<Result<Result<T>>>>>>
FlattenResolvableResulteExt7 on Resolvable<Result<Result<Result<Result<Result<Result<T>>>>>>>
FlattenResolvableResulteExt8 on Resolvable<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>
FlattenResolvableResulteExt9 on Resolvable<Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>>
FlattenResolvableResultExt2 on Resolvable<Result<T>>
FlattenResultExt2 on Result<Result<T>>
FlattenResultExt3 on Result<Result<Result<T>>>
FlattenResultExt4 on Result<Result<Result<Result<T>>>>
FlattenResultExt5 on Result<Result<Result<Result<Result<T>>>>>
FlattenResultExt6 on Result<Result<Result<Result<Result<Result<T>>>>>>
FlattenResultExt7 on Result<Result<Result<Result<Result<Result<Result<T>>>>>>>
FlattenResultExt8 on Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>
FlattenResultExt9 on Result<Result<Result<Result<Result<Result<Result<Result<Result<T>>>>>>>>>
FlattenSomeExt2 on Some<Some<T>>
FlattenSomeExt3 on Some<Some<Some<T>>>
FlattenSomeExt4 on Some<Some<Some<Some<T>>>>
FlattenSomeExt5 on Some<Some<Some<Some<Some<T>>>>>
FlattenSomeExt6 on Some<Some<Some<Some<Some<Some<T>>>>>>
FlattenSomeExt7 on Some<Some<Some<Some<Some<Some<Some<T>>>>>>>
FlattenSomeExt8 on Some<Some<Some<Some<Some<Some<Some<Some<T>>>>>>>>
FlattenSomeExt9 on Some<Some<Some<Some<Some<Some<Some<Some<Some<T>>>>>>>>>
FlattenSyncExt2 on Sync<Sync<T>>
FlattenSyncExt3 on Sync<Sync<Sync<T>>>
FlattenSyncExt4 on Sync<Sync<Sync<Sync<T>>>>
FlattenSyncExt5 on Sync<Sync<Sync<Sync<Sync<T>>>>>
FlattenSyncExt6 on Sync<Sync<Sync<Sync<Sync<Sync<T>>>>>>
FlattenSyncExt7 on Sync<Sync<Sync<Sync<Sync<Sync<Sync<T>>>>>>>
FlattenSyncExt8 on Sync<Sync<Sync<Sync<Sync<Sync<Sync<Sync<T>>>>>>>>
FlattenSyncExt9 on Sync<Sync<Sync<Sync<Sync<Sync<Sync<Sync<Sync<T>>>>>>>>>
FutureIterableOkExt on Future<Iterable<Ok<T>>>
FutureIterableSomeExt on Future<Iterable<Some<T>>>
HeadersWithSplitValues on BaseResponse
IterableAsyncExt on Iterable<Async<T>>
IterableExt on Iterable<T>
IterableFutureOptionExt on Iterable<Future<Option<T>>>
IterableFutureResultExt on Iterable<Future<Result<T>>>
IterableOkExt on Iterable<Ok<T>>
IterableOptionExt on Iterable<Option<T>>
IterableResolvableExt on Iterable<Resolvable<T>>
IterableResultExt on Iterable<Result<T>>
IterableSomeExt on Iterable<Some<T>>
IterableSyncExt on Iterable<Sync<T>>
MapExt on Map<K, V>
MapOfOptions on Map<K, Option<V>>
MapOfResults on Map<K, Result<V>>
MapOutcomeExt10 on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>>>>>
MapOutcomeExt2 on Outcome<Outcome<Object>>
MapOutcomeExt3 on Outcome<Outcome<Outcome<Object>>>
MapOutcomeExt4 on Outcome<Outcome<Outcome<Outcome<Object>>>>
MapOutcomeExt5 on Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>
MapOutcomeExt6 on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>
MapOutcomeExt7 on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>>
MapOutcomeExt8 on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>>>
MapOutcomeExt9 on Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Outcome<Object>>>>>>>>>
NoneIfEmptyOnListExt on List<T>
NoneIfEmptyOnSetExt on Set<T>
ResolvableOptionExt on Resolvable<Option<T>>
StringExt on String
SwapAsyncNoneExt on Async<None<T>>
SwapAsyncOkExt on Async<Ok<T>>
SwapAsyncSomeExt on Async<Some<T>>
SwapErrAsyncExt on Err<Async<T>>
SwapErrNoneExt on Err<None<T>>
SwapErrOkExt on Err<Ok<T>>
SwapErrOptionExt on Err<Option<T>>
SwapErrResolvableExt on Err<Resolvable<T>>
SwapErrResultExt on Err<Result<T>>
SwapErrSomeExt on Err<Some<T>>
SwapErrSyncExt on Err<Sync<T>>
SwapNoneAsyncExt on None<Async<T>>
SwapNoneErrExt on None<Err<T>>
SwapNoneOkExt on None<Ok<T>>
SwapNoneOptionExt on None<Option<T>>
SwapNoneResolvableExt on None<Resolvable<T>>
SwapNoneResultExt on None<Result<T>>
SwapNoneSomeExt on None<Some<T>>
SwapNoneSyncExt on None<Sync<T>>
SwapOkAsyncExt on Ok<Async<T>>
SwapOkErrExt on Ok<Err<T>>
SwapOkNoneExt on Ok<None<T>>
SwapOkOptionExt on Ok<Option<T>>
SwapOkResolvableExt on Ok<Resolvable<T>>
SwapOkResultExt on Ok<Result<T>>
SwapOkSomeExt on Ok<Some<T>>
SwapOkSyncExt on Ok<Sync<T>>
SwapOptionAsyncExt on Option<Async<T>>
SwapOptionErrExt on Option<Err<T>>
SwapOptionNoneExt on Option<None<T>>
SwapOptionOkExt on Option<Ok<T>>
SwapOptionResolvableExt on Option<Resolvable<T>>
SwapOptionResultExt on Option<Result<T>>
SwapOptionSomeExt on Option<Some<T>>
SwapOptionSyncExt on Option<Sync<T>>
SwapResolvableNoneExt on Resolvable<None<T>>
SwapResolvableOkExt on Resolvable<Ok<T>>
SwapResolvableSomeExt on Resolvable<Some<T>>
SwapResultAsyncExt on Result<Async<T>>
SwapResultErrExt on Result<Err<T>>
SwapResultNoneExt on Result<None<T>>
SwapResultOkExt on Result<Ok<T>>
SwapResultOptionExt on Result<Option<T>>
SwapResultResolvableExt on Result<Resolvable<T>>
SwapResultSomeExt on Result<Some<T>>
SwapResultSyncExt on Result<Sync<T>>
SwapSomeAsyncExt on Some<Async<T>>
SwapSomeErrExt on Some<Err<T>>
SwapSomeNoneExt on Some<None<T>>
SwapSomeOkExt on Some<Ok<T>>
SwapSomeOptionExt on Some<Option<T>>
SwapSomeResolvableExt on Some<Resolvable<T>>
SwapSomeResultExt on Some<Result<T>>
SwapSomeSyncExt on Some<Sync<T>>
SwapSyncAsyncExt on Sync<Async<T>>
SwapSyncErrExt on Sync<Err<T>>
SwapSyncNoneExt on Sync<None<T>>
SwapSyncOkExt on Sync<Ok<T>>
SwapSyncOptionExt on Sync<Option<T>>
SwapSyncResolvableExt on Sync<Resolvable<T>>
SwapSyncResultExt on Sync<Result<T>>
SwapSyncSomeExt on Sync<Some<T>>
SyncOptionExt on Sync<Option<T>>
ToAsyncExt on Future<T>
ToResolvableExt on FutureOr<T>
ToSafeStreamExt 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>
ToUnitOnObjectNone on None<Object>
ToUnitOnObjectOk on Ok<Object>
ToUnitOnObjectOption on Option<Object>
ToUnitOnObjectOutcome on Outcome<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>
ToUnitOnVoidNone on None<void>
ToUnitOnVoidOk on Ok<void>
ToUnitOnVoidOption on Option<void>
ToUnitOnVoidOutcome on Outcome<void>
ToUnitOnVoidResolvable on Resolvable<void>
ToUnitOnVoidResult on Result<void>
ToUnitOnVoidSome on Some<void>
ToUnitOnVoidSync on Sync<void>
ToVoidOnAsyncExt on Async<T>
ToVoidOnErrExt on Err<T>
ToVoidOnNoneExt on None<T>
ToVoidOnOkExt on Ok<T>
ToVoidOnOptionExt on Option<T>
ToVoidOnOutcomeExt on Outcome<T>
ToVoidOnResolvableExt on Resolvable<T>
ToVoidOnResultExt on Result<T>
ToVoidOnSomeExt on Some<T>
ToVoidOnSyncExt on Sync<T>
TrOnStringX on String
ValueListenableExt on ValueListenable<T>
WrapOnAsyncExt on Async<T>
WrapOnErrExt on Err<T>
WrapOnNoneExt on None<T>
WrapOnOkExt on Ok<T>
WrapOnOptionExt on Option<T>
WrapOnOutcomeExt on M
WrapOnResolvableExt on Resolvable<T>
WrapOnResultExt on Result<T>
WrapOnSomeExt on Some<T>
WrapOnSyncExt on Sync<T>

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.
NONE_UNIT → const None<Unit>
OK_UNIT → const Ok<Unit>
SOME_UNIT → const Some<Unit>
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>>
asyncSome<T extends Object>(FutureOr<T> value) → Async<Some<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.
combineOutcome<T extends Object>(Iterable<Outcome<T>> outcomes, {Err<List<Option<T>>> onErr(List<Result<Option<T>>> allResults)?}) → Resolvable<List<Option<T>>>
Combines an iterable of Outcomes 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>(dynamic input) → Option<T>
Parses a JSON input into an object of type T, returning None on failure.
jsonEncode(Object? object, {Object? toEncodable(Object? nonEncodable)?}) → String
Converts object to a JSON string.
letAsOrNone<T extends Object>(dynamic input) → Option<T>
Casts input to type T, returning None on failure.
letAsStringOrNone(dynamic input) → Option<String>
Converts input to String, returning None on failure.
letBoolOrNone(dynamic input) → Option<bool>
Converts input to bool, returning None on failure.
letDateTimeOrNone(dynamic input) → Option<DateTime>
Converts input to bool, returning None on failure.
letDoubleOrNone(dynamic input) → Option<double>
Converts input to double, returning None on failure.
letIntOrNone(dynamic input) → Option<int>
Converts input to int, returning None on failure.
letIterableOrNone<T extends Object>(dynamic input) → Option<Iterable<Option<T>>>
Converts input to Iterable<Option<T>>, returning None on failure.
letListOrNone<T extends Object>(dynamic input) → Option<List<Option<T>>>
Supported types:
letMapOrNone<K extends Object, V extends Object>(dynamic input) → Option<Map<K, Option<V>>>
Converts input to Map<K, Option<V>>, returning None on failure.
letNumOrNone(dynamic input) → Option<num>
Converts input to num, returning None on failure.
letOrNone<T extends Object>(dynamic input) → Option<T>
Attempts to convert a dynamic input to the specified type T, returning None on failure.
letSetOrNone<T extends Object>(dynamic input) → Option<Set<Option<T>>>
Supported types:
letUriOrNone(dynamic input) → Option<Uri>
Converts input to Uri, returning None on failure.
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>>
resolvableSome<T extends Object>(T value) → Resolvable<Some<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.
syncNone<T extends Object>() → Sync<None<T>>
syncSome<T extends Object>(T value) → Sync<Some<T>>
syncUnit() → Sync<Unit>
UNSAFE<T>(T block()) → T
Executes a block of code that is considered UNSAFE, allowing the use of methods like Outcome.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 Outcome operations.

Typedefs

ByteConversionSinkBase = ByteConversionSink
This class provides a base-class for converters that need to accept byte inputs.
GenericPod<T extends Object> = GenericPodMixin<T>
An alias for GenericPod.
LazyConstructor<T extends Object> = Resolvable<T> Function()
MapOptionPartition<K, V extends Object> = ({List<K> noneKeys, Map<K, V> someParts})
The result of partitioning a Map<K, Option<V>>.
MapResultPartition<K, V extends Object> = ({Map<K, Err<V>> errParts, Map<K, V> okParts})
The result of partitioning a Map<K, Result<V>>.
OptionPartition<T extends Object> = ({Iterable<None<T>> noneParts, Iterable<Some<T>> someParts})
The result of partitioning an Iterable<Option<T>>.
Pod<T extends Object> = RootPod<T>
An alias for Pod.
ResolvablePartition<T extends Object> = ({Iterable<Async<T>> asyncParts, Iterable<Sync<T>> syncParts})
The result of partitioning an Iterable<Resolvable<T>>.
ResultPartition<T extends Object> = ({Iterable<Err<T>> errParts, Iterable<Ok<T>> okParts})
The result of partitioning an Iterable<Result<T>>.
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.
TAsyncAsync<T extends Object> = Async<Async<T>>
Represents a nested Async.
TAsyncErr<T extends Object> = Async<Err<T>>
Represents an Async that contains an Err.
TAsyncNone<T extends Object> = Async<None<T>>
Represents an Async that contains a None.
TAsyncOk<T extends Object> = Async<Ok<T>>
Represents an Async that contains an Ok.
TAsyncOption<T extends Object> = Async<Option<T>>
Represents an Async that contains an Option.
TAsyncResolvable<T extends Object> = Async<Resolvable<T>>
Represents an Async that contains a Resolvable.
TAsyncResult<T extends Object> = Async<Result<T>>
Represents an Async that contains a Result.
TAsyncSome<T extends Object> = Async<Some<T>>
Represents an Async that contains a Some.
TAsyncSync<T extends Object> = Async<Sync<T>>
Represents an Async that contains a Sync.
TErrAsync<T extends Object> = Err<Async<T>>
Represents an Err that contains an Async.
TErrErr<T extends Object> = Err<Err<T>>
Represents a nested Err.
TErrNone<T extends Object> = Err<None<T>>
Represents an Err that contains a None.
TErrOk<T extends Object> = Err<Ok<T>>
Represents an Err that contains an Ok.
TErrOption<T extends Object> = Err<Option<T>>
Represents an Err that contains an Option.
TErrResolvable<T extends Object> = Err<Resolvable<T>>
Represents an Err that contains a Resolvable.
TErrResult<T extends Object> = Err<Result<T>>
Represents an Err that contains a Result.
TErrSome<T extends Object> = Err<Some<T>>
Represents an Err that contains a Some.
TErrSync<T extends Object> = Err<Sync<T>>
Represents an Err that contains a Sync.
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)
TOkAsync<T extends Object> = Ok<Async<T>>
Represents an Ok that contains an Async.
TOkErr<T extends Object> = Ok<Err<T>>
Represents an Ok that contains an Err.
TOkNone<T extends Object> = Ok<None<T>>
Represents an Ok that contains a None.
TOkOk<T extends Object> = Ok<Ok<T>>
Represents a nested Ok.
TOkOption<T extends Object> = Ok<Option<T>>
Represents an Ok that contains an Option.
TOkResolvable<T extends Object> = Ok<Resolvable<T>>
Represents an Ok that contains a Resolvable.
TOkResult<T extends Object> = Ok<Result<T>>
Represents an Ok that contains a Result.
TOkSome<T extends Object> = Ok<Some<T>>
Represents an Ok that contains a Some.
TOkSync<T extends Object> = Ok<Sync<T>>
Represents an Ok that contains a Sync.
TOnBeforeDispose<T> = void Function(T value)?
TOnErrorCallback<T extends Object> = Err<T> Function(Object? error, StackTrace stackTrace)
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)
TOnTaskConpletedCallback<T extends Object> = Resolvable<Unit> Function(Task<T> task, double executionProgress)
TOnTaskError = Resolvable<Object> Function(Err<Object> err)
A function that handles an error from a previous task as a side-effect.
TOptionAsync<T extends Object> = Option<Async<T>>
Represents an Option that contains an Async.
TOptionErr<T extends Object> = Option<Err<T>>
Represents an Option that contains an Err.
TOptionNone<T extends Object> = Option<None<T>>
Represents an Option that contains a None.
TOptionOk<T extends Object> = Option<Ok<T>>
Represents an Option that contains an Ok.
TOptionOption<T extends Object> = Option<Option<T>>
Represents a nested Option.
TOptionResolvable<T extends Object> = Option<Resolvable<T>>
Represents an Option that contains a Resolvable.
TOptionResult<T extends Object> = Option<Result<T>>
Represents an Option that contains a Result.
TOptionSome<T extends Object> = Option<Some<T>>
Represents an Option that contains a Some.
TOptionSync<T extends Object> = Option<Sync<T>>
Represents an Option that contains a Sync.
TPodsResponderFn<T extends Object> = Iterable<GenericPod<T>> Function()
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)
TResolvableErr<T extends Object> = Resolvable<Err<T>>
Represents a Resolvable that contains an Err.
TResolvableNone<T extends Object> = Resolvable<None<T>>
Represents a Resolvable that contains a None.
TResolvableOk<T extends Object> = Resolvable<Ok<T>>
Represents a Resolvable that contains an Ok.
TResolvableOption<T extends Object> = Resolvable<Option<T>>
Represents a Resolvable that contains an Option.
TResolvableResolvable<T extends Object> = Resolvable<Resolvable<T>>
Represents a nested Resolvable.
TResolvableResult<T extends Object> = Resolvable<Result<T>>
Represents a Resolvable that contains a Result.
TResolvableSome<T extends Object> = Resolvable<Some<T>>
Represents a Resolvable that contains a Some.
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()
TResultAsync<T extends Object> = Result<Async<T>>
Represents a Result that contains an Async.
TResultErr<T extends Object> = Result<Err<T>>
Represents a Result that contains an Err.
TResultNone<T extends Object> = Result<None<T>>
Represents a Result that contains a None.
TResultOk<T extends Object> = Result<Ok<T>>
Represents a Result that contains an Ok.
TResultOption<T extends Object> = Result<Option<T>>
Represents a Result that contains an Option.
TResultResolvable<T extends Object> = Result<Resolvable<T>>
Represents a Result that contains a Resolvable.
TResultResult<T extends Object> = Result<Result<T>>
Represents a nested Result.
TResultSome<T extends Object> = Result<Some<T>>
Represents a Result that contains a Some.
TResultStream<T extends Object> = Stream<Result<T>>
TResultSync<T extends Object> = Result<Sync<T>>
Represents a Result that contains a Sync.
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>
TSomeAsync<T extends Object> = Some<Async<T>>
Represents a Some that contains an Async.
TSomeErr<T extends Object> = Some<Err<T>>
Represents a Some that contains an Err.
TSomeNone<T extends Object> = Some<None<T>>
Represents a Some that contains a None.
TSomeOk<T extends Object> = Some<Ok<T>>
Represents a Some that contains an Ok.
TSomeOption<T extends Object> = Some<Option<T>>
Represents a Some that contains an Option.
TSomeResolvable<T extends Object> = Some<Resolvable<T>>
Represents a Some that contains a Resolvable.
TSomeResult<T extends Object> = Some<Result<T>>
Represents a Some that contains a Result.
TSomeSome<T extends Object> = Some<Some<T>>
Represents a nested Some.
TSomeSync<T extends Object> = Some<Sync<T>>
Represents a Some that contains a Sync.
TSyncAsync<T extends Object> = Sync<Async<T>>
Represents a Sync that contains an Async.
TSyncErr<T extends Object> = Sync<Err<T>>
Represents a Sync that contains an Err.
TSyncNone<T extends Object> = Sync<None<T>>
Represents a Sync that contains a None.
TSyncOk<T extends Object> = Sync<Ok<T>>
Represents a Sync that contains an Ok.
TSyncOption<T extends Object> = Sync<Option<T>>
Represents a Sync that contains an Option.
TSyncResolvable<T extends Object> = Sync<Resolvable<T>>
Represents a Sync that contains a Resolvable.
TSyncResult<T extends Object> = Sync<Result<T>>
Represents a Sync that contains a Result.
TSyncSome<T extends Object> = Sync<Some<T>>
Represents a Sync that contains a Some.
TSyncSync<T extends Object> = Sync<Sync<T>>
Represents a nested Sync.
TTaskHandler<T extends Object> = TResolvableOption<T> Function(TResultOption<T> previous)
A function that defines a step in a task sequence. It receives the result of the previous task.
TTransaltionMap = Map<String, TranslatedText>
TValuesReducerFn<TChild, TParentList> = TChild Function(List<TParentList> parentValues)
TVoidCallback = void Function()

Exceptions / Errors

ClientException
An exception caused by an error in a pkg/http client.
Err<T extends Object>
A Outcome 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.
RequestAbortedException
Thrown when an HTTP request is aborted.