Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(600)

Unified Diff: lib/result.dart

Issue 1218813011: Add handle method to ErrorResult. (Closed) Base URL: https://github.com/dart-lang/async@master
Patch Set: Created 5 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | test/result_test.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: lib/result.dart
diff --git a/lib/result.dart b/lib/result.dart
index c734a37a5b24632725973988f8a97456f9d0bb77..13e3dd94b288d8e579f3cc8a77eb88430f179356 100644
--- a/lib/result.dart
+++ b/lib/result.dart
@@ -2,31 +2,25 @@
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
-/**
- * Capture asynchronous results into synchronous values, and release them again.
- *
- * Capturing a result (either a returned value or a thrown error)
- * means converting it into a [Result] -
- * either a [ValueResult] or an [ErrorResult].
- *
- * This value can release itself by writing itself either to a
- * [EventSink] or a [Completer], or by becoming a [Future].
- */
+/// Capture asynchronous results into synchronous values.
+///
+/// Capturing a result (either a returned value or a thrown error)
+/// means converting it into a [Result] -
+/// either a [ValueResult] or an [ErrorResult].
+///
+/// This value can release itself by writing itself either to a
+/// [EventSink] or a [Completer], or by becoming a [Future].
library dart.pkg.async.results;
import "dart:async";
-/**
- * The result of a computation.
- */
+/// The result of a computation.
abstract class Result<T> {
- /**
- * Create a `Result` with the result of calling [computation].
- *
- * This generates either a [ValueResult] with the value returned by
- * calling `computation`, or an [ErrorResult] with an error thrown by
- * the call.
- */
+ /// Create a `Result` with the result of calling [computation].
+ ///
+ /// This generates either a [ValueResult] with the value returned by
+ /// calling `computation`, or an [ErrorResult] with an error thrown by
+ /// the call.
factory Result(T computation()) {
try {
return new ValueResult(computation());
@@ -35,18 +29,14 @@ abstract class Result<T> {
}
}
- /**
- * Create a `Result` holding a value.
- *
- * Alias for [ValueResult.ValueResult].
- */
+ /// Create a `Result` holding a value.
+ ///
+ /// Alias for [ValueResult.ValueResult].
factory Result.value(T value) = ValueResult<T>;
- /**
- * Create a `Result` holding an error.
- *
- * Alias for [ErrorResult.ErrorResult].
- */
+ /// Create a `Result` holding an error.
+ ///
+ /// Alias for [ErrorResult.ErrorResult].
factory Result.error(Object error, [StackTrace stackTrace]) =>
new ErrorResult(error, stackTrace);
@@ -58,118 +48,92 @@ abstract class Result<T> {
return v.asFuture;
}
- /**
- * Capture the result of a future into a `Result` future.
- *
- * The resulting future will never have an error.
- * Errors have been converted to an [ErrorResult] value.
- */
+ /// Capture the result of a future into a `Result` future.
+ ///
+ /// The resulting future will never have an error.
+ /// Errors have been converted to an [ErrorResult] value.
static Future<Result> capture(Future future) {
return future.then(_captureValue, onError: _captureError);
}
- /**
- * Release the result of a captured future.
- *
- * Converts the [Result] value of the given [future] to a value or error
- * completion of the returned future.
- *
- * If [future] completes with an error, the returned future completes with
- * the same error.
- */
+ /// Release the result of a captured future.
+ ///
+ /// Converts the [Result] value of the given [future] to a value or error
+ /// completion of the returned future.
+ ///
+ /// If [future] completes with an error, the returned future completes with
+ /// the same error.
static Future release(Future<Result> future) {
return future.then(_release);
}
- /**
- * Capture the results of a stream into a stream of [Result] values.
- *
- * The returned stream will not have any error events.
- * Errors from the source stream have been converted to [ErrorResult]s.
- *
- * Shorthand for transforming the stream using [CaptureStreamTransformer].
- */
+ /// Capture the results of a stream into a stream of [Result] values.
+ ///
+ /// The returned stream will not have any error events.
+ /// Errors from the source stream have been converted to [ErrorResult]s.
+ ///
+ /// Shorthand for transforming the stream using [CaptureStreamTransformer].
static Stream<Result> captureStream(Stream source) {
return source.transform(const CaptureStreamTransformer());
}
- /**
- * Release a stream of [result] values into a stream of the results.
- *
- * `Result` values of the source stream become value or error events in
- * the returned stream as appropriate.
- * Errors from the source stream become errors in the returned stream.
- *
- * Shorthand for transforming the stream using [ReleaseStreamTransformer].
- */
+ /// Release a stream of [result] values into a stream of the results.
+ ///
+ /// `Result` values of the source stream become value or error events in
+ /// the returned stream as appropriate.
+ /// Errors from the source stream become errors in the returned stream.
+ ///
+ /// Shorthand for transforming the stream using [ReleaseStreamTransformer].
static Stream releaseStream(Stream<Result> source) {
return source.transform(const ReleaseStreamTransformer());
}
- /**
- * Converts a result of a result to a single result.
- *
- * If the result is an error, or it is a `Result` value
- * which is then an error, then a result with that error is returned.
- * Otherwise both levels of results are value results, and a single
- * result with the value is returned.
- */
+ /// Converts a result of a result to a single result.
+ ///
+ /// If the result is an error, or it is a `Result` value
+ /// which is then an error, then a result with that error is returned.
+ /// Otherwise both levels of results are value results, and a single
+ /// result with the value is returned.
static Result flatten(Result<Result> result) {
if (result.isError) return result;
return result.asValue.value;
}
- /**
- * Whether this result is a value result.
- *
- * Always the opposite of [isError].
- */
+ /// Whether this result is a value result.
+ ///
+ /// Always the opposite of [isError].
bool get isValue;
- /**
- * Whether this result is an error result.
- *
- * Always the opposite of [isValue].
- */
+ /// Whether this result is an error result.
+ ///
+ /// Always the opposite of [isValue].
bool get isError;
- /**
- * If this is a value result, return itself.
- *
- * Otherwise return `null`.
- */
+ /// If this is a value result, return itself.
+ ///
+ /// Otherwise return `null`.
ValueResult<T> get asValue;
- /**
- * If this is an error result, return itself.
- *
- * Otherwise return `null`.
- */
+ /// If this is an error result, return itself.
+ ///
+ /// Otherwise return `null`.
ErrorResult get asError;
- /**
- * Complete a completer with this result.
- */
+ /// Complete a completer with this result.
void complete(Completer<T> completer);
- /**
- * Add this result to a [StreamSink].
- */
+ /// Add this result to an [EventSink].
+ ///
+ /// Calls the sink's `add` or `addError` method as appropriate.
void addTo(EventSink<T> sink);
- /**
- * Creates a future completed with this result as a value or an error.
- */
+ /// Creates a future completed with this result as a value or an error.
Future<T> get asFuture;
}
-/**
- * A result representing a returned value.
- */
+/// A result representing a returned value.
class ValueResult<T> implements Result<T> {
- /** The returned value that this result represents. */
final T value;
- /** Create a value result with the given [value]. */
ValueResult(this.value);
bool get isValue => true;
bool get isError => false;
@@ -184,15 +148,10 @@ class ValueResult<T> implements Result<T> {
Future<T> get asFuture => new Future.value(value);
}
-/**
- * A result representing a thrown error.
- */
+/// A result representing a thrown error.
class ErrorResult implements Result {
- /** The thrown object that this result represents. */
final error;
- /** The stack trace, if any, associated with the throw. */
final StackTrace stackTrace;
- /** Create an error result with the given [error] and [stackTrace]. */
ErrorResult(this.error, this.stackTrace);
bool get isValue => false;
bool get isError => true;
@@ -205,14 +164,26 @@ class ErrorResult implements Result {
sink.addError(error, stackTrace);
}
Future get asFuture => new Future.error(error, stackTrace);
+
+ /// Calls an error handler with the error and stacktrace.
+ ///
+ /// An async error handler function is either a function expecting two
+ /// arguments, which will be called with the error and the stack trace,
+ /// or it has to be a function expecting only one argument,
+ /// which will be called with only the error.
+ void handle(Function errorHandler) {
+ if (errorHandler is ZoneBinaryCallback) {
+ errorHandler(error, stackTrace);
+ } else {
+ errorHandler(error);
+ }
+ }
}
-/**
- * A stream transformer that captures a stream of events into [Result]s.
- *
- * The result of the transformation is a stream of [Result] values and
- * no error events.
- */
+/// A stream transformer that captures a stream of events into [Result]s.
+///
+/// The result of the transformation is a stream of [Result] values and
+/// no error events.
class CaptureStreamTransformer<T> implements StreamTransformer<T, Result<T>> {
const CaptureStreamTransformer();
@@ -225,12 +196,10 @@ class CaptureStreamTransformer<T> implements StreamTransformer<T, Result<T>> {
}
}
-/**
- * A stream transformer that releases a stream of result events.
- *
- * The result of the transformation is a stream of values and
- * error events.
- */
+/// A stream transformer that releases a stream of result events.
+///
+/// The result of the transformation is a stream of values and
+/// error events.
class ReleaseStreamTransformer<T> implements StreamTransformer<Result<T>, T> {
const ReleaseStreamTransformer();
@@ -243,15 +212,13 @@ class ReleaseStreamTransformer<T> implements StreamTransformer<Result<T>, T> {
}
}
-/**
- * An event sink wrapper that captures the incoming events.
- *
- * Wraps an [EventSink] that expects [Result] values.
- * Accepts any value and error result,
- * and passes them to the wrapped sink as [Result] values.
- *
- * The wrapped sink will never receive an error event.
- */
+/// An event sink wrapper that captures the incoming events.
+///
+/// Wraps an [EventSink] that expects [Result] values.
+/// Accepts any value and error result,
+/// and passes them to the wrapped sink as [Result] values.
+///
+/// The wrapped sink will never receive an error event.
class CaptureSink<T> implements EventSink<T> {
final EventSink _sink;
@@ -263,13 +230,11 @@ class CaptureSink<T> implements EventSink<T> {
void close() { _sink.close(); }
}
-/**
- * An event sink wrapper that releases the incoming result events.
- *
- * Wraps an output [EventSink] that expects any result.
- * Accepts [Result] values, and puts the result value or error into the
- * corresponding output sink add method.
- */
+/// An event sink wrapper that releases the incoming result events.
+///
+/// Wraps an output [EventSink] that expects any result.
+/// Accepts [Result] values, and puts the result value or error into the
+/// corresponding output sink add method.
class ReleaseSink<T> implements EventSink<Result<T>> {
final EventSink _sink;
ReleaseSink(EventSink<T> sink) : _sink = sink;
« no previous file with comments | « no previous file | test/result_test.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698