@@ -172,17 +172,25 @@ import kotlin.coroutines.*
172
172
*
173
173
* **The `Flow` interface is not stable for inheritance in 3rd party libraries**, as new methods
174
174
* might be added to this interface in the future, but is stable for use.
175
+ *
175
176
* Use the `flow { ... }` builder function to create an implementation, or extend [AbstractFlow].
177
+ * These implementations ensure that the context preservation property is not violated, and prevent most
178
+ * of the developer mistakes related to concurrency, inconsistent flow dispatchers, and cancellation.
176
179
*/
177
180
public interface Flow <out T > {
181
+
178
182
/* *
179
183
* Accepts the given [collector] and [emits][FlowCollector.emit] values into it.
180
- * This method should never be implemented or used directly.
181
184
*
182
- * The only way to implement the `Flow` interface directly is to extend [AbstractFlow].
183
- * To collect it into a specific collector, either `collector.emitAll(flow)` or `collect { ... }` extension
184
- * should be used. Such limitation ensures that the context preservation property is not violated and prevents most
185
- * of the developer mistakes related to concurrency, inconsistent flow dispatchers and cancellation.
185
+ * This method can be used along with SAM-conversion of [FlowCollector]:
186
+ * ```
187
+ * myFlow.collect { value -> println("Collected $value")
188
+ * ```
189
+ *
190
+ * ### Method inheritance
191
+ *
192
+ * To ensure the context preservation property, it is not recommended implementing this method directly.
193
+ * Instead, [AbstractFlow] can be used as the base type to properly ensure flow's properties.
186
194
*/
187
195
public suspend fun collect (collector : FlowCollector <T >)
188
196
}
0 commit comments