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

Unified Diff: lib/src/stream_sink_transformer.dart

Issue 1566603002: Add a StreamSinkTransformer class. (Closed) Base URL: git@github.com:dart-lang/async.git@master
Patch Set: Code review changes Created 4 years, 11 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 | « lib/async.dart ('k') | lib/src/stream_sink_transformer/handler_transformer.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: lib/src/stream_sink_transformer.dart
diff --git a/lib/src/stream_sink_transformer.dart b/lib/src/stream_sink_transformer.dart
new file mode 100644
index 0000000000000000000000000000000000000000..a8410ab245539975894ebc1542a25c5e83ad4e88
--- /dev/null
+++ b/lib/src/stream_sink_transformer.dart
@@ -0,0 +1,50 @@
+// Copyright (c) 2016, the Dart project authors. Please see the AUTHORS file
+// 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.
+
+library async.stream_sink_transformer;
+
+import 'dart:async';
+
+import 'stream_sink_transformer/handler_transformer.dart';
+import 'stream_sink_transformer/stream_transformer_wrapper.dart';
+
+/// A [StreamSinkTransformer] transforms the events being passed to a sink.
+///
+/// This works on the same principle as a [StreamTransformer]. Each transformer
+/// defines a [bind] method that takes in the original [StreamSink] and returns
+/// the transformed version. However, where a [StreamTransformer] transforms
+/// events after they leave the stream, this transforms them before they enter
+/// the sink.
+///
+/// Transformers must be able to have `bind` called used multiple times.
+abstract class StreamSinkTransformer<S, T> {
+ /// Creates a [StreamSinkTransformer] that transforms events and errors
+ /// using [transformer].
+ ///
+ /// This is equivalent to piping all events from the outer sink through a
+ /// stream transformed by [transformer] and from there into the inner sink.
+ const factory StreamSinkTransformer.fromStreamTransformer(
+ StreamTransformer<S, T> transformer) =
+ StreamTransformerWrapper<S, T>;
+
+ /// Creates a [StreamSinkTransformer] that delegates events to the given
+ /// handlers.
+ ///
+ /// The handlers work exactly as they do for [StreamTransformer.fromHandlers].
+ /// They're called for each incoming event, and any actions on the sink
+ /// they're passed are forwarded to the inner sink. If a handler is omitted,
+ /// the event is passed through unaltered.
+ factory StreamSinkTransformer.fromHandlers({
+ void handleData(S data, EventSink<T> sink),
+ void handleError(Object error, StackTrace stackTrace, EventSink<T> sink),
+ void handleDone(EventSink<T> sink)}) {
+ return new HandlerTransformer<S, T>(handleData, handleError, handleDone);
+ }
+
+ /// Transforms the events passed to [sink].
+ ///
+ /// Creates a new sink. When events are passed to the returned sink, it will
+ /// transform them and pass the transformed versions to [sink].
+ StreamSink<S> bind(StreamSink<T> sink);
+}
« no previous file with comments | « lib/async.dart ('k') | lib/src/stream_sink_transformer/handler_transformer.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698