convenience_types library

Classes

AppError

Abstract class to model errors on the application. As a presset of foreseen specific errors there are some different implementations of this type. Namely: HttpError models errors related to http requests CacheError models cache errors DeviceInfoError models device's information gathering related errors FormError models form related errors StorageError models storage operations related errors

AppUnknownError

CacheError

Abstract class to model errors on the application. As a presset of foreseen specific errors there are some different implementations of this type. CacheError models cache errors

DefaultErrorMessages

DeviceInfoError

Abstract class to model errors on the application. As a presset of foreseen specific errors there are some different implementations of this type. DeviceInfoError models device's information gathering related errors

DeviceInfoNotFoundError

DeviceInfoError models device's information gathering error related to device info not found

DeviceInfoUnknownError

DeviceInfoError models device's information gathering error related to device info unknown or malformed

EntityNotFitError

Failed<ResultType>

FailedToCacheError

FailedToCacheError models failure in the action of caching an info

FailedToShareError

FailedToUnloadError

FailedToUnloadError models failure araised from trying to delete a cached file

Failure<ResultType>

FileAlreadyCachedError

FileAlreadyCachedError models failure araised from trying to cache an already cached file

FormError

FormError models any error that might happen while operating with a form

FormField<T>

When providing data to a form and then passing it forward, for instance, in a request body, one problem that is common here is the need of dealing with the cases where the field is not filled, and than one might need to treat every possible resulting Map (json) separetily, either passing the not filled field with no value or not passing it at all.

FormUtils

Class used as a dart Mixin to a Form class, providing methods to conviniently deal with validation and serialization of fields.

HttpBadRequestError<T>

HttpNetworkError models http errors with status 400

HttpError<T>

Abstract class to model errors on the application. As a presset of foreseen specific errors there are some different implementations of this type. HttpError models errors related to http requests

HttpForbiddenError<T>

HttpForbiddenError models http errors with status 403

HttpGoneError<T>

HttpGoneError models http errors with status 410

HttpInternalServerError<T>

HttpInternalServerError models http errors with status 500

HttpNetworkError<T>

HttpNetworkError models errors related to network connection

HttpNotFoundError<T>

HttpNotFoundError models http errors with status 404

HttpUnauthorizedError<T>

HttpUnauthorizedError models http errors with status 401

HttpUnknownError<T>

HttpUnknownError models unknown http errors

Idle<ResultType>

Just<T>

Loading<ResultType>

Maybe<T>

Dealing with optional values ​​in ui has always been verbose and unsafe. So the

NoInternetConnectionError<T>

NoInternetConnectionError models errors related with failure in communication associated with failure of internet connection

NotCachedError

NotCachedError models failure araised from trying retrieve a file not yet cached

Nothing<T>

ParseError

RequestStatus<ResultType>

When one is dealing with ui responses to different request states, in the course of it, usually there are four states of interest Idle, Loading, Succeded or Failed.

Result<ResultType>

Every asynchronus task can have two possible outcomes as a Result. It is either a Success or a Failure. So the

StorageError

Abstract class to model errors on the application. As a presset of foreseen specific errors there are some different implementations of this type. StorageError models errors related to storage operations

StorageNotFoundError

StorageNotFoundError models the error of not finding device's storage

StorageUnknownError

StorageUnknownError models unknown or unexpected storage related errors

Succeeded<ResultType>

Success<ResultType>

TokenNotFoundError

UnprocessableEntityError<T>

UnprocessableEntityError models http errors with status 422

Extensions

MaybeRecordX on (Maybe<K>, Maybe<J>)

Functions

parseHttpError<T>({required DioException error, StackTrace stackTrace = StackTrace.empty, String slug = '', String handleErrorMessage({required DioException error})?, T? errorResponseSerializer(dynamic)?, String defaultErrorMessage = "Algo inesperado aconteceu. Tente novamente mais tarde.", String defaultNoInternetConnectionMessage = ''}) → Future<HttpError<T>>

parseSocketException<T>({required String msg, required DioException exception, String slug = '', Maybe<T> maybeErrorResponse = const Nothing()}) → Future<HttpError<T>>

Typedefs

Validator<Type> = String? Function(Type)

Exceptions / Errors

CacheException

CacheException models the exception to be thrown in case an illegal operation happens during caching request

ParseException

ParseException models the exception to be thrown in case of an illegal operation happens during the process of parsing data, Example: SomeModel.fromJson throw ParseException