Add document of observe(QFuture<QFuture<T>>)

benlau · Dec 28, 2017 · 24a0130 · 24a0130
1 parent 62314df
commit 24a0130
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -225,6 +225,35 @@ observe(future).subscribe([](bool toggled) {
 });
 ```
 
+AsyncFuture::observe(QFuture&lt;QFuture&lt;T&gt;T&gt; future)
+-----
+
+This function creates an Observable<T> object which provides an interface for observing the input future.  That is designed to handle following use-case:
+
+```
+QFuture<QImage> readImagesFromFolder(const QString& folder) {
+
+    auto worker = [=]() {
+        // Read files from a directory in a thread
+        QStringList files = findImageFiles(folder);
+
+        // Concurrent image reader
+        return QtConcurrent::mapped(files, readImage);
+    };
+
+    auto future = QtConcurrent::run(worker); // The type of future is QFuture<QFuture<QImage>>
+
+    auto defer = AsyncFuture::deferred<QImage>();
+
+    // defer object track the input future. It will emit "started" and `progressValueChanged` according to the status of the future of "QtConcurrent::mapped"
+    defer.complete(future);
+    return defer.future();
+}
+```
+
+See [Observable`<T>`](#observablet)
+
+
 
 AsyncFuture::combine(CombinatorMode mode = FailFast)
 ------------

diff --git a/qpm.json b/qpm.json
@@ -10,7 +10,7 @@
     "url": "[email protected]:benlau/asyncfuture.git"
   },
   "version": {
-    "label": "0.3.6.5",
+    "label": "0.4.0",
     "revision": "",
     "fingerprint": ""
   },