higorlapa/result
Result package for dart
go to github downloadmultiple_result
Result package for dart inspired by the work of dartz’s Either and Kotlin’s sealed classes.
This package is perfect to those of you who just want the Multiple results
functionality from dartz. 👌
About version 4.0.0 and previous releases
Versions 3.0.0 to 3.2.0 represented the common effort in making this package better. That’s why so many breaking changes
in just a small time.
Once these updates stopped (because they decided to fork the project) I decided to remove these updates
and keep it simple as it was always supposed to be. It’s open to suggestions and you should not expect
more of these breaking changes any time soon. The package will keep evolving and responding to dart’s updates.
Use Result type:
In the return of a function, set it to return a Result type;
Result getSomethingPretty();
then add the Success and the Error types.
Result<String, Exception> getSomethingPretty() {
}
in return of the function, you just need to return
return Success('Something Pretty');
or
return Error(Exception('something ugly happened...'));
The function should look something like this:
Result<String, Exception> getSomethingPretty() {
if(isOk) {
return Success('OK!');
} else {
return Error(Exception('Not Ok!'));
}
}
Handling the Result with switch
:
void main() {
final result = getSomethingPretty();
switch(result) {
case Success():
print("${result.success}");
break;
case Error():
print("${result.error}");
break;
}
}
Handling the Result with when
:
void main() {
final result = getSomethingPretty();
final String message = result.when(
(success) {
// handle the success here
return "success";
},
(error) {
// handle the error here
return "error";
},
);
}
Handling the Result with if case
:
void main() {
final result = getSomethingPretty();
if(result case Success()) {
// access to .success value
print("${result.success}");
}
}
Handling the Result with whenSuccess
or whenError
final result = getSomethingPretty();
// notice that [whenSuccess] or [whenError] will only be executed if
// the result is a Success or an Error respectivaly.
final output = result.whenSuccess((name) {
// handle here the success
return "";
});
final result = getSomethingPretty();
// [result] is NOT an Error, this [output] will be null.
final output = result.whenError((exception) {
// handle here the error
return "";
});
Handling the Result with getOrThrow
You may use the getOrThrow
to get the value when you’re sure that the result was a Success
.
Be aware that accessing this method when the result is actually an Error
will throw a SuccessResultNotFoundException
.
final result = getSomethingPretty();
if (result.isSuccess()) {
final mySuccessResult = result.getOrThrow();
}
Handling the Result with tryGetSuccess
void main() {
final result = getSomethingPretty();
String? mySuccessResult;
if (result.isSuccess()) {
mySuccessResult = result.tryGetSuccess();
}
}
Handling the Result with tryGetError
void main() {
final result = getSomethingPretty();
Exception? myException;
if (result.isError()) {
myException = result.tryGetError();
}
}
Unit Type
Some results do not need a specific return. Use the Unit type to signal an empty return.
Result<Unit, Exception>
ResultOf
You may have noticed the ResultOf
typedef. It represents a better readability for Result
, but as
it would be another breaking change, leaving it as an alias would be good enough.
![](/images/banner-woo.jpg)
excellent projects related to higorlapa/result recommend downloading
AppFlowy
47859
AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
localsend
33797
An open-source cross-platform alternative to AirDrop
spotube
23772
🎧 Open source Spotify client that doesn't require Premium nor uses Electron! Available for both desktop & mobile!
revanced-manager
15035
💊 Application to use ReVanced on Android
gsy_github_app_flutter
14559
Flutter 超完整的开源项目,功能丰富,适合学习和日常使用。GSYGithubApp系列的优势:我们目前已经拥有Flutter、Weex、ReactNative、kotlin 四个版本。 功能齐全,项目框架内技术涉及面广,完成度高,持续维护,配套文章,适合全面学习,对比参考。跨平台的开源Github客户端App,更好的体验,更丰富的功能,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验Σ( ̄。 ̄ノ)ノ。同款Weex版本 : https://github.com/CarGuo/GSYGithubAppWeex 、同款React Native版本 : https://github.com/CarGuo/GSYGithubApp 、原生 kotlin 版本 https://github.com/CarGuo/GSYGithubAppKotlin
dio
12249
A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc.
gopeed
11832
A modern download manager that supports all platforms. Built with Golang and Flutter.
bloc
11441
A predictable state management library that helps implement the BLoC design pattern
getx
9899
Open screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.
flame
8846
A Flutter based game engine.
flutter_deer
7595
🦌 Flutter 练习项目(包括集成测试、可访问性测试)。内含完整UI设计图,更贴近真实项目的练习。Flutter practice project (including integration testing and accessibility testing). Contains complete UI design drawings for a more realistic practice project.
fish-redux
7343
An assembled flutter application framework.
hiddify-next
7232
Multi-platform auto-proxy client, supporting Sing-box, X-ray, TUIC, Hysteria, Reality, Trojan, SSH etc. It’s an open-source, secure and ad-free.
ente
6686
Fully open source, End to End Encrypted alternative to Google Photos and Apple Photos
fl_chart
6451
FL Chart is a highly customizable Flutter chart library that supports Line Chart, Bar Chart, Pie Chart, Scatter Chart, and Radar Chart.
pixez-flutter
6360
一个支持免代理直连及查看动图的第三方Pixiv flutter客户端
Flutter-Responsive-Admin-Panel-or-Dashboard
6355
Responsive Admin Panel or Dashboard using Flutter
aidea
6021
AIdea 是一款支持 GPT 以及国产大语言模型通义千问、文心一言等,支持 Stable Diffusion 文生图、图生图、 SDXL1.0、超分辨率、图片上色的全能型 APP。
riverpod
5828
A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
pikapika
5463
美观易用且无广告的漫画和游戏客户端,同时支持MacOS,Windows,Android,iOS。