mirror of
https://github.com/ReactiveX/RxSwift.git
synced 2024-10-05 06:27:29 +03:00
Add inline comment describing the MaterializedSequenceResult enum type
This commit is contained in:
parent
1b9962b817
commit
4469683446
@ -10,6 +10,14 @@
|
||||
import RxSwift
|
||||
#endif
|
||||
|
||||
/// The `MaterializedSequenceResult` enum represents the materialized
|
||||
/// output of a BlockingObservable.
|
||||
///
|
||||
/// If the sequence terminates successfully, the result is represented
|
||||
/// by `.completed` with the array of elements.
|
||||
///
|
||||
/// If the sequene terminates with error, the result is represented
|
||||
/// by `.failed` with both the array of elements and the terminating error.
|
||||
public enum MaterializedSequenceResult<T> {
|
||||
case completed(elements: [T])
|
||||
case failed(elements: [T], error: Error)
|
||||
|
Loading…
Reference in New Issue
Block a user