ReactiveX/RxSwift
1
1
Fork 0
mirror of https://github.com/ReactiveX/RxSwift.git synced 2024-10-05 06:27:29 +03:00
Code Issues Projects Releases Wiki Activity

Add inline comment describing the MaterializedSequenceResult enum type

Browse Source
This commit is contained in:
Stewart Gleadow 2017-08-21 21:02:53 +10:00 committed by Krunoslav Zaher
parent 1b9962b817
commit 4469683446
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
RxBlocking/BlockingObservable+Operators.swift
View File

@ -10,6 +10,14 @@
import RxSwift import RxSwift
#endif #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> { public enum MaterializedSequenceResult<T> {
case completed(elements: [T]) case completed(elements: [T])
case failed(elements: [T], error: Error) case failed(elements: [T], error: Error)