flutter-result-errors
Skill10 starsChanged 41 days agoMITView on GitHub
Use when writing or reviewing Flutter data-layer, repository or provider code that can fail, when adding Result/AsyncResult types or failure types, when mapping exceptions to user-facing errors, or when an exception is crossing a layer boundary. Sets up a sealed AppFailure taxonomy, Result typedefs over result_dart, one catch boundary (RemoteDataSourceGuard) and the way presentation folds failures.
In this repository5 other files it gives its agents.
- flutter-feature-scaffoldSkill
- flutter-riverpod3Skill
- flutter-sdk-contractsSkill
- flutter-testingSkill
- flutter-ui-side-effectsSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 149
Add a final class XFailure extends AppFailure (with its own kind) when the UI must treat a case differently from the generic ones, e.g.
- Very specific: line 161
Never rethrow, never throw in a repository or data source.
- Very specific: line 162
Do not catch inside the repository to "add context": wrap at the data source (guard) or add a typed failure.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Result-based error handling for Flutter
Nothing throws across a layer boundary. Every data-source and repository
method returns a Result that is either a value or an AppFailure.
Why
- A thrown exception is invisible in a method signature; a
Resultis not. Callers cannot forget the failure path. AppFailureis sealed, so aswitchover it is exhaustive. Adding a failure type becomes a compile error everywhere it is not handled.- Exactly one place catches infrastructure exceptions, so mapping, logging and error reporting live in one funnel instead of N try/catch.
Setup (once per project)
Copy these from this skill's assets/ and replace your_app with the
package name in pubspec.yaml. Add result_dart to dependencies.
| Asset | Destination |
app_failure.dart, result.dart, errors.dart | lib/core/errors/ |
api_exception.dart, remote_data_source_guard.dart | lib/core/network/ |
submission_notifier.dart | lib/core/utils/ |
Feature code imports core/errors/errors.dart, never
package:result_dart directly, so the package stays swappable.
Where a file also imports flutter_riverpod, use
import 'package:flutter_riverpod/flutter_riverpod.dart' hide AsyncResult;
to avoid a name clash with the app typedef.
Layer responsibilities
| Layer | Does | Never |
| Remote data source | Wraps every request in guard(...); parses JSON into models | Contains try/catch; returns entities |
| Repository | Calls data sources, maps models → entities with result.map(...) | Catches, throws, or leaks models/DTOs |
| Domain | Pure Dart | Throws or catches |
| Presentation | Folds the Result into UI state | Reads failure.message for UI copy |
Writing a data source
class ProfileRemoteDataSourceImpl
with RemoteDataSourceGuard
implements ProfileRemoteDataSource {
ProfileRemoteDataSourceImpl(this._apiClient);
final ApiClient _apiClient;
@override
AsyncResult<ProfileModel> fetchProfile() {
return guard(() async {
final response = await _apiClient.get(ProfileEndpoints.me);
final data = response['data'] as Map<String, dynamic>;
return ProfileModel.fromJson(data);
});
}
}guard already handles timeouts (→ NetworkFailure), ApiException
(→ via toAppFailure()), and anything else (→ UnknownFailure carrying the
error and stack trace). Do not add a second try/catch around it.
Operations that return no data use AsyncResult<Unit>:
AsyncResult<Unit> deleteAccount() => guard(() async {
await _apiClient.delete(AccountEndpoints.me);
return unit;
});Writing a repository
The repository only converts; it passes failures through untouched.
@override
AsyncResult<Profile> getProfile() async {
final result = await _remote.fetchProfile();
return result.map((model) => model.toEntity());
}
@override
AsyncResult<Unit> deleteAccount() async {
final result = await _remote.deleteAccount();
return result.map((_) => unit);
}Consuming in presentation
Reads — bridge into Riverpod's AsyncValue. getOrThrow() inside a
provider is the one sanctioned throw: it surfaces as AsyncError to the UI.
class StatsNotifier extends AsyncNotifier<Stats> {
@override
Future<Stats> build() async {
final result = await ref.watch(statsRepositoryProvider).getStats();
return result.getOrThrow();
}
}Actions (submit, toggle, delete) — extend SubmissionNotifier<T> so a
button press gets loading / data / error state without setState:
class FavoriteSubmissionNotifier extends SubmissionNotifier<Unit> {
Future<void> remove(String id) =>
run(() => ref.read(favoritesProvider.notifier).remove(id));
}
final favoriteSubmissionProvider =
NotifierProvider.autoDispose<FavoriteSubmissionNotifier, AsyncValue<Unit?>>(
FavoriteSubmissionNotifier.new,
);Idle is AsyncData(null). The notifier is autoDispose so a stale error
resets when the screen is left. run ignores a second call while loading
(double-tap guard) and survives the provider being disposed mid-request.
UI copy comes from l10n keyed on the failure type:
String failureMessage(AppLocalizations l10n, AppFailure failure) =>
switch (failure) {
NetworkFailure() => l10n.errorNetwork,
AuthFailure() => l10n.errorSessionExpired,
CancelledFailure() => '', // an answer, not a fault: stay silent
_ => l10n.errorGeneric,
};Drop the _ arm if you want the compiler to force every new failure to
be handled. Keep it when a feature-specific mapper falls back to a shared
baseline (match domain failures first, then delegate).
Extending the taxonomy
Add a final class XFailure extends AppFailure (with its own kind) when
the UI must treat a case differently from the generic ones, e.g.
CancelledFailure (silent), a store refusing purchases, a social sign-in
sheet dismissed. If the UI would show the same copy as an existing failure,
reuse that one.
Gotchas
kindis a hand-written string, notruntimeType.toString(): minification reducesruntimeTypeto a letter in release builds.failure.messageis for logs only. Never show it to users.UnknownFailurekeepserrorandstackTrace; report from there.- Never
rethrow, neverthrowin a repository or data source. - Do not catch inside the repository to "add context": wrap at the data
source (
guard) or add a typed failure. - Per-endpoint timeout: override
requestTimeoutin the data source.
Testing
Fake the ApiClient, throw an ApiException, assert the Result:
test('maps 401 to AuthFailure', () async {
when(() => api.get(any())).thenThrow(const ApiResponseException(statusCode: 401));
final result = await dataSource.fetchProfile();
expect(result.exceptionOrNull(), isA<AuthFailure>());
});Review checklist
- No
try/catchorthrowin repositories or data sources (outsideguard) - Every repository/data-source method returns
AsyncResult<…> - No
package:result_dartimport in feature code - Models are converted to entities before leaving the repository
- UI strings come from l10n by failure type, not from
failure.message - New failure types are sealed subclasses with a literal
kind
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

