-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Alphabetical List of Observable Operators
akarnokd edited this page Jun 5, 2019
·
142 revisions
-
aggregate(â)â seereduce(â) -
all(âŊ)â determine whether all items emitted by an Observable meet some criteria -
amb(â)â given two or more source Observables, emits all of the items from the first of these Observables to emit an item -
ambWith(â)â instance version ofamb(â) -
and(â)â combine the emissions from two or more source Observables into aPattern(rxjava-joins) -
apply(â)(scala) â seecreate(âŊ) -
asObservable(â)(kotlin) â seefrom(âŊ)(et al.) -
asyncAction(âŊ)â convert an Action into an Observable that executes the Action and emits its return value (rxjava-async) -
asyncFunc(âŊ)â convert a function into an Observable that executes the function and emits its return value (rxjava-async) -
averageDouble(âŊ)â calculates the average of Doubles emitted by an Observable and emits this average (rxjava-math) -
averageFloat(âŊ)â calculates the average of Floats emitted by an Observable and emits this average (rxjava-math) -
averageInteger(âŊ)â calculates the average of Integers emitted by an Observable and emits this average (rxjava-math) -
averageLong(âŊ)â calculates the average of Longs emitted by an Observable and emits this average (rxjava-math) -
blocking(â)(clojure) â seetoBlocking(â) -
buffer(â)â periodically gather items from an Observable into bundles and emit these bundles rather than emitting the items one at a time -
byLine(â)(StringObservable) â converts an Observable of Strings into an Observable of Lines by treating the source sequence as a stream and splitting it on line-endings -
cache(âŊ)â remember the sequence of items emitted by the Observable and emit the same sequence to future Subscribers -
cast(â)â cast all items from the source Observable into a particular type before reemitting them -
catch(â)(clojure) â seeonErrorResumeNext(âŊ) -
chunkify(â)â returns an iterable that periodically returns a list of items emitted by the source Observable since the last list (â) -
collect(â)â collects items emitted by the source Observable into a single mutable data structure and returns an Observable that emits this structure -
combineLatest(â)â 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 -
combineLatestWith(â)(scala) â instance version ofcombineLatest(â) -
concat(â)â concatenate two or more Observables sequentially -
concatMap(â)â transform the items emitted by an Observable into Observables, then flatten this into a single Observable, without interleaving -
concatWith(â)â instance version ofconcat(â) -
connect(âŊ)â instructs a Connectable Observable to begin emitting items -
cons(â)(clojure) â seeconcat(â) -
contains(âŊ)â determine whether an Observable emits a particular item or not -
count(âŊ)â counts the number of items emitted by an Observable and emits this count -
countLong(âŊ)â counts the number of items emitted by an Observable and emits this count -
create(âŊ)â create an Observable from scratch by means of a function -
cycle(â)(clojure) â seerepeat(âŊ) -
debounce(â)â only emit an item from the source Observable after a particular timespan has passed without the Observable emitting any other items -
decode(â)(StringObservable) â convert a stream of multibyte characters into an Observable that emits byte arrays that respect character boundaries -
defaultIfEmpty(â)â emit items from the source Observable, or emit a default item if the source Observable completes after emitting no items -
defer(âŊ)â do not create the Observable until a Subscriber subscribes; create a fresh Observable on each subscription -
deferFuture(âŊ)â convert a Future that returns an Observable into an Observable, but do not attempt to get the Observable that the Future returns until a Subscriber subscribes (rxjava-async) -
deferCancellableFuture(âŊ)â convert a Future that returns an Observable into an Observable in a way that monitors the subscription status of the Observable to determine whether to halt work on the Future, but do not attempt to get the returned Observable until a Subscriber subscribes (â)(rxjava-async) -
delay(âŊ)â shift the emissions from an Observable forward in time by a specified amount -
dematerialize(âŊ)â convert a materialized Observable back into its non-materialized form -
distinct(â)â suppress duplicate items emitted by the source Observable -
distinctUntilChanged(â)â suppress duplicate consecutive items emitted by the source Observable -
do(â)(clojure) â seedoOnEach(âŊ) -
doOnCompleted(âŊ)â register an action to take when an Observable completes successfully -
doOnEach(âŊ)â register an action to take whenever an Observable emits an item -
doOnError(âŊ)â register an action to take when an Observable completes with an error -
doOnNext(â)â seedoOnEach(âŊ) -
doOnRequest(â)â register an action to take when items are requested from an Observable via reactive-pull backpressure (â) -
doOnSubscribe(âŊ)â register an action to take when an observer subscribes to an Observable -
doOnTerminate(âŊ)â register an action to take when an Observable completes, either successfully or with an error -
doOnUnsubscribe(âŊ)â register an action to take when an observer unsubscribes from an Observable -
doWhile(âŊ)â emit the source Observable's sequence, and then repeat the sequence as long as a condition remains true (contrib-computation-expressions) -
drop(â)(scala/clojure) â seeskip(â) -
dropRight(â)(scala) â seeskipLast(â) -
dropUntil(â)(scala) â seeskipUntil(â) -
dropWhile(â)(scala) â seeskipWhile(â) -
drop-while(â)(clojure) â seeskipWhile(â) -
elementAt(â)â emit item n emitted by the source Observable -
elementAtOrDefault(â)â emit item n emitted by the source Observable, or a default item if the source Observable emits fewer than n items -
empty(âŊ)â create an Observable that emits nothing and then completes -
encode(â)(StringObservable) â transform an Observable that emits strings into an Observable that emits byte arrays that respect character boundaries of multibyte characters in the original strings -
error(âŊ)â create an Observable that emits nothing and then signals an error -
every(â)(clojure) â seeall(âŊ) -
exists(âŊ)â determine whether an Observable emits any items or not -
filter(â)â filter items emitted by an Observable -
finally(â)(clojure) â seefinallyDo(âŊ) -
filterNot(â)(scala) â seefilter(â) -
finallyDo(âŊ)â register an action to take when an Observable completes -
first(â)(Observable) â emit only the first item emitted by an Observable, or the first item that meets some condition -
first(â)(BlockingObservable) â emit only the first item emitted by an Observable, or the first item that meets some condition -
firstOrDefault(â)(Observable) â emit only the first item emitted by an Observable, or the first item that meets some condition, or a default value if the source Observable is empty -
firstOrDefault(â)(BlockingObservable) â emit only the first item emitted by an Observable, or the first item that meets some condition, or a default value if the source Observable is empty -
firstOrElse(â)(scala) â seefirstOrDefault(â)orfirstOrDefault(â)(BlockingObservable) -
flatMap(â)â transform the items emitted by an Observable into Observables, then flatten this into a single Observable -
flatMapIterable(â)â create Iterables corresponding to each emission from a source Observable and merge the results into a single Observable -
flatMapIterableWith(â)(scala) â instance version offlatMapIterable(â) -
flatMapWith(â)(scala) â instance version offlatmap(â) -
flatten(â)(scala) â seemerge(â) -
flattenDelayError(â)(scala) â seemergeDelayError(â) -
foldLeft(â)(scala) â seereduce(â) -
forall(â)(scala) â seeall(âŊ) -
forEach(â)(Observable) â seesubscribe(â) -
forEach(â)(BlockingObservable) â invoke a function on each item emitted by the Observable; block until the Observable completes -
forEachFuture(âŊ)(Async) â pass Subscriber methods to an Observable but also have it behave like a Future that blocks until it completes (rxjava-async) -
forEachFuture(â)(BlockingObservable)â create a futureTask that will invoke a specified function on each item emitted by an Observable (â) -
forIterable(âŊ)â apply a function to the elements of an Iterable to create Observables which are then concatenated (â) -
from(âŊ)â convert an Iterable, a Future, or an Array into an Observable -
from(â)(StringObservable) â convert a stream of characters or a Reader into an Observable that emits byte arrays or Strings -
fromAction(âŊ)â convert an Action into an Observable that invokes the action and emits its result when a Subscriber subscribes (rxjava-async) -
fromCallable(âŊ)â convert a Callable into an Observable that invokes the callable and emits its result or exception when a Subscriber subscribes (rxjava-async) -
fromCancellableFuture(âŊ)â convert a Future into an Observable in a way that monitors the subscription status of the Observable to determine whether to halt work on the Future, but do not attempt to get the Future's value until a Subscriber subscribes (â)(rxjava-async) -
fromFunc0(â)â seefromCallable(âŊ)(rxjava-async) -
fromFuture(âŊ)â convert a Future into an Observable, but do not attempt to get the Future's value until a Subscriber subscribes (â) -
fromRunnable(âŊ)â convert a Runnable into an Observable that invokes the runable and emits its result when a Subscriber subscribes (rxjava-async) -
generate(âŊ)â create an Observable that emits a sequence of items as generated by a function of your choosing (â) -
generateAbsoluteTime(âŊ)â create an Observable that emits a sequence of items as generated by a function of your choosing, with each item emitted at an item-specific time (â) -
generator(â)(clojure) â seegenerate(âŊ) -
getIterator(â)â convert the sequence emitted by the Observable into an Iterator -
groupBy(â)â divide an Observable into a set of Observables that emit groups of items from the original Observable, organized by key -
group-by(â)(clojure) â seegroupBy(â) -
groupByUntil(â)â a variant of thegroupBy(â)operator that closes any open GroupedObservable upon a signal from another Observable (â) -
groupJoin(â)â combine the items emitted by two Observables whenever one item from one Observable falls within a window of duration specified by an item emitted by the other Observable -
head(â)(scala) â seefirst(â)(BlockingObservable) -
headOption(â)(scala) â seefirstOrDefault(â)orfirstOrDefault(â)(BlockingObservable) -
headOrElse(â)(scala) â seefirstOrDefault(â)orfirstOrDefault(â)(BlockingObservable) -
ifThen(âŊ)â only emit the source Observable's sequence if a condition is true, otherwise emit an empty or default sequence (contrib-computation-expressions) -
ignoreElements(â)â discard the items emitted by the source Observable and only pass through the error or completed notification -
interval(âŊ)â create an Observable that emits a sequence of integers spaced by a given time interval -
into(â)(clojure) â seereduce(â) -
isEmpty(âŊ)â determine whether an Observable emits any items or not -
items(â)(scala) â seejust(âŊ) -
join(â)â combine the items emitted by two Observables whenever one item from one Observable falls within a window of duration specified by an item emitted by the other Observable -
join(â)(StringObservable) â converts an Observable that emits a sequence of strings into an Observable that emits a single string that concatenates them all, separating them by a specified string -
just(âŊ)â convert an object into an Observable that emits that object -
last(â)(BlockingObservable) â block until the Observable completes, then return the last item emitted by the Observable -
last(â)(Observable) â emit only the last item emitted by the source Observable -
lastOption(â)(scala) â seelastOrDefault(â)orlastOrDefault(â)(BlockingObservable) -
lastOrDefault(â)(BlockingObservable) â block until the Observable completes, then return the last item emitted by the Observable or a default item if there is no last item -
lastOrDefault(â)(Observable) â emit only the last item emitted by an Observable, or a default value if the source Observable is empty -
lastOrElse(â)(scala) â seelastOrDefault(â)orlastOrDefault(â)(BlockingObservable) -
latest(â)â returns an iterable that blocks until or unless the Observable emits an item that has not been returned by the iterable, then returns the latest such item -
length(â)(scala) â seecount(âŊ) -
limit(â)â seetake(â) -
longCount(âŊ)(scala) â seecountLong(âŊ) -
map(â)â transform the items emitted by an Observable by applying a function to each of them -
mapcat(â)(clojure) â seeconcatMap(â) -
mapMany(â)â see:flatMap(â) -
materialize(âŊ)â convert an Observable into a list of Notifications -
max(âŊ)â emits the maximum value emitted by a source Observable (rxjava-math) -
maxBy(âŊ)â emits the item emitted by the source Observable that has the maximum key value (rxjava-math) -
merge(â)â combine multiple Observables into one -
mergeDelayError(â)â combine multiple Observables into one, allowing error-free Observables to continue before propagating errors -
merge-delay-error(â)(clojure) â seemergeDelayError(â) -
mergeMap(â)* â see:flatMap(â) -
mergeMapIterable(â)â see:flatMapIterable(â) -
mergeWith(â)â instance version ofmerge(â) -
min(âŊ)â emits the minimum value emitted by a source Observable (rxjava-math) -
minBy(âŊ)â emits the item emitted by the source Observable that has the minimum key value (rxjava-math) -
mostRecent(â)â returns an iterable that always returns the item most recently emitted by the Observable -
multicast(âŊ)â represents an Observable as a Connectable Observable -
never(âŊ)â create an Observable that emits nothing at all -
next(â)â returns an iterable that blocks until the Observable emits another item, then returns that item -
nonEmpty(â)(scala) â seeisEmpty(âŊ) -
nth(â)(clojure) â seeelementAt(â)andelementAtOrDefault(â) -
observeOn(âŊ)â specify on which Scheduler a Subscriber should observe the Observable -
ofType(â)â emit only those items from the source Observable that are of a particular class -
onBackpressureBlock(â)â block the Observable's thread until the Observer is ready to accept more items from the Observable (â) -
onBackpressureBuffer(â)â maintain a buffer of all emissions from the source Observable and emit them to downstream Subscribers according to the requests they generate -
onBackpressureDrop(â)â drop emissions from the source Observable unless there is a pending request from a downstream Subscriber, in which case emit enough items to fulfill the request -
onErrorFlatMap(âŊ)â instructs an Observable to emit a sequence of items whenever it encounters an error (â) -
onErrorResumeNext(âŊ)â instructs an Observable to emit a sequence of items if it encounters an error -
onErrorReturn(âŊ)â instructs an Observable to emit a particular item when it encounters an error -
onExceptionResumeNext(âŊ)â instructs an Observable to continue emitting items after it encounters an exception (but not another variety of throwable) -
orElse(â)(scala) â seedefaultIfEmpty(â) -
parallel(âŊ)â split the work done on the emissions from an Observable into multiple Observables each operating on its own parallel thread (â) -
parallelMerge(â)â combine multiple Observables into smaller number of Observables (â) -
pivot(â)â combine multiple sets of grouped observables so that they are arranged primarily by group rather than by set (â) -
publish(âŊ)â represents an Observable as a Connectable Observable -
publishLast(âŊ)â represent an Observable as a Connectable Observable that emits only the last item emitted by the source Observable (â) -
range(âŊ)â create an Observable that emits a range of sequential integers -
reduce(â)â apply a function to each emitted item, sequentially, and emit only the final accumulated value -
reductions(â)(clojure) â seescan(â) -
refCount(âŊ)â makes a Connectable Observable behave like an ordinary Observable -
repeat(âŊ)â create an Observable that emits a particular item or sequence of items repeatedly -
repeatWhen(âŊ)â create an Observable that emits a particular item or sequence of items repeatedly, depending on the emissions of a second Observable -
replay(âŊ)â ensures that all Subscribers see the same sequence of emitted items, even if they subscribe after the Observable begins emitting the items -
rest(â)(clojure) â seenext(â) -
return(â)(clojure) â seejust(âŊ) -
retry(âŊ)â if a source Observable emits an error, resubscribe to it in the hopes that it will complete without error -
retrywhen(âŊ)â if a source Observable emits an error, pass that error to another Observable to determine whether to resubscribe to the source -
runAsync(âŊ)â returns aStoppableObservablethat emits multiple actions as generated by a specified Action on a Scheduler (rxjava-async) -
sample(â)â emit the most recent items emitted by an Observable within periodic time intervals -
scan(â)â apply a function to each item emitted by an Observable, sequentially, and emit each successive value -
seq(â)(clojure) â seegetIterator(â) -
sequenceEqual(âŊ)â test the equality of sequences emitted by two Observables -
sequenceEqualWith(â)(scala) â instance version ofsequenceEqual(âŊ) -
serialize(âŊ)â force an Observable to make serialized calls and to be well-behaved -
share(â)â seerefCount(âŊ) -
single(â)(BlockingObservable) â if the source Observable completes after emitting a single item, return that item, otherwise throw an exception -
single(â)(Observable) â if the source Observable completes after emitting a single item, emit that item, otherwise notify of an exception -
singleOption(â)(scala) â seesingleOrDefault(â)(BlockingObservable) -
singleOrDefault(â)(BlockingObservable) â if the source Observable completes after emitting a single item, return that item, otherwise return a default item -
singleOrDefault(â)(Observable) â if the source Observable completes after emitting a single item, emit that item, otherwise emit a default item -
singleOrElse(â)(scala) â seesingleOrDefault(â) -
size(â)(scala) â seecount(âŊ) -
skip(â)â ignore the first n items emitted by an Observable -
skipLast(â)â ignore the last n items emitted by an Observable -
skipUntil(â)â discard items emitted by a source Observable until a second Observable emits an item, then emit the remainder of the source Observable's items -
skipWhile(â)â discard items emitted by an Observable until a specified condition is false, then emit the remainder -
sliding(â)(scala) â seewindow(â) -
slidingBuffer(â)(scala) â seebuffer(â) -
split(â)(StringObservable) â converts an Observable of Strings into an Observable of Strings that treats the source sequence as a stream and splits it on a specified regex boundary -
start(âŊ)â create an Observable that emits the return value of a function (rxjava-async) -
startCancellableFuture(âŊ)â convert a function that returns Future into an Observable that emits that Future's return value in a way that monitors the subscription status of the Observable to determine whether to halt work on the Future (â)(rxjava-async) -
startFuture(âŊ)â convert a function that returns Future into an Observable that emits that Future's return value (rxjava-async) -
startWith(â)â emit a specified sequence of items before beginning to emit the items from the Observable -
stringConcat(â)(StringObservable) â converts an Observable that emits a sequence of strings into an Observable that emits a single string that concatenates them all -
subscribeOn(âŊ)â specify which Scheduler an Observable should use when its subscription is invoked -
sumDouble(âŊ)â adds the Doubles emitted by an Observable and emits this sum (rxjava-math) -
sumFloat(âŊ)â adds the Floats emitted by an Observable and emits this sum (rxjava-math) -
sumInt(âŊ)â adds the Integers emitted by an Observable and emits this sum (rxjava-math) -
sumLong(âŊ)â adds the Longs emitted by an Observable and emits this sum (rxjava-math) -
switch(â)(scala) â seeswitchOnNext(â) -
switchCase(â)â emit the sequence from a particular Observable based on the results of an evaluation (contrib-computation-expressions) -
switchMap(â)â transform the items emitted by an Observable into Observables, and mirror those items emitted by the most-recently transformed Observable -
switchOnNext(â)â convert an Observable that emits Observables into a single Observable that emits the items emitted by the most-recently emitted of those Observables -
synchronize(âŊ)â seeserialize(âŊ) -
take(â)â emit only the first n items emitted by an Observable -
takeFirst(â)â emit only the first item emitted by an Observable, or the first item that meets some condition -
takeLast(â)â only emit the last n items emitted by an Observable -
takeLastBuffer(â)â emit the last n items emitted by an Observable, as a single list item -
takeRight(â)(scala) â seelast(â)(Observable) ortakeLast(â) -
takeUntil(â)â emits the items from the source Observable until a second Observable emits an item -
takeWhile(â)â emit items emitted by an Observable as long as a specified condition is true, then skip the remainder -
take-while(â)(clojure) â seetakeWhile(â) -
then(â)â transform a series ofPatternobjects via aPlantemplate (rxjava-joins) -
throttleFirst(â)â emit the first items emitted by an Observable within periodic time intervals -
throttleLast(â)â emit the most recent items emitted by an Observable within periodic time intervals -
throttleWithTimeout(â)â only emit an item from the source Observable after a particular timespan has passed without the Observable emitting any other items -
throw(â)(clojure) â seeerror(âŊ) -
timeInterval(âŊ)â emit the time lapsed between consecutive emissions of a source Observable -
timeout(â)â emit items from a source Observable, but issue an exception if no item is emitted in a specified timespan -
timer(â)â create an Observable that emits a single item after a given delay -
timestamp(âŊ)â attach a timestamp to every item emitted by an Observable -
toAsync(âŊ)â convert a function or Action into an Observable that executes the function and emits its return value (rxjava-async) -
toBlocking(â)â transform an Observable into a BlockingObservable -
toBlockingObservable(â)- seetoBlocking(â) -
toFuture(â)â convert the Observable into a Future -
toIterable(â)â convert the sequence emitted by the Observable into an Iterable -
toIterator(â)â seegetIterator(â) -
toList(âŊ)â collect all items from an Observable and emit them as a single List -
toMap(âŊ)â convert the sequence of items emitted by an Observable into a map keyed by a specified key function -
toMultimap(âŊ)â convert the sequence of items emitted by an Observable into an ArrayList that is also a map keyed by a specified key function -
toSeq(â)(scala) â seetoList(âŊ) -
toSortedList(âŊ)â collect all items from an Observable and emit them as a single, sorted List -
tumbling(â)(scala) â seewindow(â) -
tumblingBuffer(â)(scala) â seebuffer(â) -
using(âŊ)â create a disposable resource that has the same lifespan as an Observable -
when(â)â convert a series ofPlanobjects into an Observable (rxjava-joins) -
where(â)â see:filter(â) -
whileDo(âŊ)â if a condition is true, emit the source Observable's sequence and then repeat the sequence as long as the condition remains true (contrib-computation-expressions) -
window(â)â periodically subdivide items from an Observable into Observable windows and emit these windows rather than emitting the items one at a time -
zip(â)â combine sets of items emitted by two or more Observables together via a specified function and emit items based on the results of this function -
zipWith(â)â instance version ofzip(â) -
zipWithIndex(â)(scala) â seezip(â) -
++(scala) â seeconcat(â) -
+:(scala) â seestartWith(â)
(â) â this proposed operator is not part of RxJava 1.0
Copyright (c) 2016-present, RxJava Contributors.
Twitter @RxJava | Gitter @RxJava