Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] add shorter way to get value from Result #281

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/async.dart
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export 'src/restartable_timer.dart';
export 'src/result/error.dart';
export 'src/result/future.dart';
export 'src/result/result.dart';
export 'src/result/result_extensions.dart';
export 'src/result/value.dart';
export 'src/single_subscription_transformer.dart';
export 'src/sink_base.dart';
Expand Down
16 changes: 16 additions & 0 deletions lib/src/result/result_extensions.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import 'result.dart';

extension ResultExtensions<T> on Result<T> {
/// Returns the value if the result [isValue].
///
/// If the result [isError], it throws the corresponding error and stacktrace.
T get requireValue {
if (isValue) return asValue!.value;
Error.throwWithStackTrace(asError!.error, asError!.stackTrace);
}

/// Returns the value if the result [isValue].
///
/// Returns null otherwise
T? get valueOrNull => asValue?.value;
}
65 changes: 65 additions & 0 deletions test/result/result_extensions_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
import 'package:async/async.dart';
import 'package:test/test.dart';

void main() {
group('test requiredValue', () {
test(
'return value when result is value',
() {
final result = Result.value(10);
expect(result.requireValue, 10);
},
);

test(
'return nullable value when result is nullable value',
() {
final result = Result<int?>.value(null);
expect(result.requireValue, null);
},
);

test(
'throw exception when result is error',
() async {
final result = Result.error('error');
expect(() => result.requireValue, throwsA(anything));
},
);

test(
'throw the corresponding and stacktrace exception when result is error',
() async {
final error = Exception();
final stacktrace = StackTrace.current;
final result = Result.error(error, stacktrace);

expect(
() => result.requireValue,
throwsA(
predicate((err) {
return err == error;
}),
),
);
},
);
});

group('test valueOrNull', () {
test('return null when result is error', () {
final result = Result.error('error');
expect(result.valueOrNull, null);
});

test('return value when result is value ', () {
final result = Result.value(10);
expect(result.valueOrNull, 10);
});

test('return nullable value when result is nullable value ', () {
final result = Result<int?>.value(null);
expect(result.valueOrNull, null);
});
});
}