1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
.. _operators:
Operators
==========
Creating Observables
---------------------
============================================= ================================================
Operator Description
============================================= ================================================
:func:`create <reactivex.create>` Create an Observable from scratch by calling observer methods programmatically.
:func:`empty <reactivex.empty>` Creates an Observable that emits no item and completes immediately.
:func:`never <reactivex.never>` Creates an Observable that never completes.
:func:`throw <reactivex.throw>` Creates an Observable that terminates with an error.
:func:`from_ <reactivex.from_>` Convert some other object or data structure into an Observable.
:func:`interval <reactivex.interval>` Create an Observable that emits a sequence of integers spaced by a particular time interval.
:func:`just <reactivex.just>` Convert an object or a set of objects into an Observable that emits that object or those objects.
:func:`range <reactivex.range>` Create an Observable that emits a range of sequential integers.
:func:`repeat_value <reactivex.repeat_value>` Create an Observable that emits a particular item or sequence of items repeatedly.
:func:`start <reactivex.start>` Create an Observable that emits the return value of a function.
:func:`timer <reactivex.timer>` Create an Observable that emits a single item after a given delay.
============================================= ================================================
Transforming Observables
------------------------
================================================ ================================================
Operator Description
================================================ ================================================
:func:`buffer <reactivex.operators.buffer>` Periodically gather items from an Observable into bundles and emit these bundles rather than emitting the items one at a time.
:func:`flat_map <reactivex.operators.flat_map>` Transform the items emitted by an Observable into Observables, then flatten the emissions from those into a single Observable.
:func:`group_by <reactivex.operators.group_by>` Divide an Observable into a set of Observables that each emit a different group of items from the original Observable, organized by key.
:func:`map <reactivex.operators.map>` Transform the items emitted by an Observable by applying a function to each item.
:func:`scan <reactivex.operators.scan>` Apply a function to each item emitted by an Observable, sequentially, and emit each successive value.
:func:`window <reactivex.operators.window>` Periodically subdivide items from an Observable into Observable windows and emit these windows rather than emitting the items one at a time.
================================================ ================================================
Filtering Observables
----------------------
============================================================= ================================================
Operator Description
============================================================= ================================================
:func:`debounce <reactivex.operators.debounce>` Only emit an item from an Observable if a particular timespan has passed without it emitting another item.
:func:`distinct <reactivex.operators.distinct>` Suppress duplicate items emitted by an Observable.
:func:`element_at <reactivex.operators.element_at>` Emit only item n emitted by an Observable.
:func:`filter <reactivex.operators.filter>` Emit only those items from an Observable that pass a predicate test.
:func:`first <reactivex.operators.first>` Emit only the first item, or the first item that meets a condition, from an Observable.
:func:`ignore_elements <reactivex.operators.ignore_elements>` Do not emit any items from an Observable but mirror its termination notification.
:func:`last <reactivex.operators.last>` Emit only the last item emitted by an Observable.
:func:`sample <reactivex.operators.sample>` Emit the most recent item emitted by an Observable within periodic time intervals.
:func:`skip <reactivex.operators.skip>` Suppress the first n items emitted by an Observable.
:func:`skip_last <reactivex.operators.skip_last>` Suppress the last n items emitted by an Observable.
:func:`take <reactivex.operators.take>` Emit only the first n items emitted by an Observable.
:func:`take_last <reactivex.operators.take_last>` Emit only the last n items emitted by an Observable.
============================================================= ================================================
Combining Observables
----------------------
============================================================= ================================================
Operator Description
============================================================= ================================================
:func:`combine_latest <reactivex.operators.combine_latest>` When an item is emitted by either of two Observables, combine the latest item emitted by each Observable via a specified function and emit items based on the results of this function.
:func:`join <reactivex.operators.join>` Combine items emitted by two Observables whenever an item from one Observable is emitted during a time window defined according to an item emitted by the other Observable.
:func:`merge <reactivex.operators.merge>` Combine multiple Observables into one by merging their emissions.
:func:`start_with <reactivex.operators.start_with>` Emit a specified sequence of items before beginning to emit the items from the source Observable.
:func:`switch_latest <reactivex.operators.switch_latest>` Convert an Observable that emits Observables into a single Observable that emits the items emitted by the most-recently-emitted of those Observables.
:func:`zip <reactivex.operators.zip>` Combine the emissions of multiple Observables together via a specified function and emit single items for each combination based on the results of this function.
:func:`fork_join <reactivex.operators.fork_join>` Wait for Observables to complete and then combine last values they emitted into a tuple.
============================================================= ================================================
Error Handling
---------------
====================================================== ================================================
Operator Description
====================================================== ================================================
:func:`catch <reactivex.operators.catch>` Continues observable sequences which are terminated with an exception by switching over to the next observable sequence.
:func:`retry <reactivex.operators.retry>` If a source Observable sends an onError notification, resubscribe to it in the hopes that it will complete without error.
====================================================== ================================================
Utility Operators
------------------
============================================================= ================================================
Operator Description
============================================================= ================================================
:func:`delay <reactivex.operators.delay>` Shift the emissions from an Observable forward in time by a particular amount.
:func:`do <reactivex.operators.do>` Register an action to take upon a variety of Observable lifecycle events.
:func:`materialize <reactivex.operators.materialize>` Materializes the implicit notifications of an observable sequence as explicit notification values.
:func:`dematerialize <reactivex.operators.dematerialize>` Dematerializes the explicit notification values of an observable sequence as implicit notifications.
:func:`observe_on <reactivex.operators.observe_on>` Specify the scheduler on which an observer will observe this Observable.
:meth:`subscribe <reactivex.Observable.subscribe>` Operate upon the emissions and notifications from an Observable.
:func:`subscribe_on <reactivex.operators.subscribe_on>` Specify the scheduler an Observable should use when it is subscribed to.
:func:`time_interval <reactivex.operators.time_interval>` Convert an Observable that emits items into one that emits indications of the amount of time elapsed between those emissions.
:func:`timeout <reactivex.operators.timeout>` Mirror the source Observable, but issue an error notification if a particular period of time elapses without any emitted items.
:func:`timestamp <reactivex.operators.timestamp>` Attach a timestamp to each item emitted by an Observable.
============================================================= ================================================
Conditional and Boolean Operators
----------------------------------
================================================================= ================================================
Operator Description
================================================================= ================================================
:func:`all <reactivex.operators.all>` Determine whether all items emitted by an Observable meet some criteria.
:func:`amb <reactivex.operators.amb>` Given two or more source Observables, emit all of the items from only the first of these Observables to emit an item.
:func:`contains <reactivex.operators.contains>` Determine whether an Observable emits a particular item or not.
:func:`default_if_empty <reactivex.operators.default_if_empty>` Emit items from the source Observable, or a default item if the source Observable emits nothing.
:func:`sequence_equal <reactivex.operators.sequence_equal>` Determine whether two Observables emit the same sequence of items.
:func:`skip_until <reactivex.operators.skip_until>` Discard items emitted by an Observable until a second Observable emits an item.
:func:`skip_while <reactivex.operators.skip_while>` Discard items emitted by an Observable until a specified condition becomes false.
:func:`take_until <reactivex.operators.take_until>` Discard items emitted by an Observable after a second Observable emits an item or terminates.
:func:`take_whle <reactivex.operators.take_while>` Discard items emitted by an Observable after a specified condition becomes false.
================================================================= ================================================
Mathematical and Aggregate Operators
-------------------------------------
================================================ ================================================
Operator Description
================================================ ================================================
:func:`average <reactivex.operators.average>` Calculates the average of numbers emitted by an Observable and emits this average.
:func:`concat <reactivex.operators.concat>` Emit the emissions from two or more Observables without interleaving them.
:func:`count <reactivex.operators.count>` Count the number of items emitted by the source Observable and emit only this value.
:func:`max <reactivex.operators.max>` Determine, and emit, the maximum-valued item emitted by an Observable.
:func:`min <reactivex.operators.min>` Determine, and emit, the minimum-valued item emitted by an Observable.
:func:`reduce <reactivex.operators.reduce>` Apply a function to each item emitted by an Observable, sequentially, and emit the final value.
:func:`sum <reactivex.operators.sum>` Calculate the sum of numbers emitted by an Observable and emit this sum.
================================================ ================================================
Connectable Observable Operators
---------------------------------
===================================================== ================================================
Operator Description
===================================================== ================================================
:meth:`connect <rx.ConnectableObservable.connect>` Instruct a connectable Observable to begin emitting items to its subscribers.
:func:`publish <reactivex.operators.publish>` Convert an ordinary Observable into a connectable Observable.
:func:`ref_count <reactivex.operators.ref_count>` Make a Connectable Observable behave like an ordinary Observable.
:func:`replay <reactivex.operators.replay>` Ensure that all observers see the same sequence of emitted items, even if they subscribe after the Observable has begun emitting items.
===================================================== ================================================
|
