blob: 320afa3992eb7a1e99e7261983a112bd9d79c8e1 [file] [log] [blame]
<html devsite="true">
<head>
<title>RxPagingDataKt</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>RxPagingDataKt</h1>
{% setvar page_path %}androidx/paging/rxjava3/RxPagingDataKt.html{% endsetvar %}
{% setvar can_switch %}1{% endsetvar %}
{% include "reference/_java_switcher2.md" %}
<p>
<pre>public final class RxPagingDataKt</pre>
</p>
<hr>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>static&nbsp;final <a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;</code></td>
<td width="100%">
<div><code>&lt;T&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/rxjava3/RxPagingDataKt.html#filter(androidx.paging.PagingData,kotlin.Function1)">filter</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/kotlin/jvm/functions/Function1.html">Function1</a>&lt;T,&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/java/lang/Boolean.html">Boolean</a>&gt;&gt;&nbsp;predicate<br>)</code></div>
<p>Returns a <code><a href="/reference/androidx/paging/PagingData.html">PagingData</a></code> containing only elements matching the given <code><a href="/reference/androidx/paging/rxjava3/package-summary.html#predicate()">predicate</a></code>.</p>
</td>
</tr>
<tr>
<td><code>static&nbsp;final <a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;R&gt;</code></td>
<td width="100%">
<div><code>&lt;T&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>,&nbsp;R&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/rxjava3/RxPagingDataKt.html#flatMap(androidx.paging.PagingData,kotlin.Function1)">flatMap</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/kotlin/jvm/functions/Function1.html">Function1</a>&lt;T,&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/java/lang/Iterable.html">Iterable</a>&lt;R&gt;&gt;&gt;&nbsp;transform<br>)</code></div>
<p>Returns a <code><a href="/reference/androidx/paging/PagingData.html">PagingData</a></code> of all elements returned from applying the given <code><a href="/reference/androidx/paging/rxjava3/package-summary.html#transform()">transform</a></code> to each element, as it is loaded.</p>
</td>
</tr>
<tr>
<td><code>static&nbsp;final <a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;R&gt;</code></td>
<td width="100%">
<div><code>&lt;T&nbsp;extends&nbsp;R,&nbsp;R&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/rxjava3/RxPagingDataKt.html#insertSeparators(androidx.paging.PagingData,kotlin.Function2)">insertSeparators</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/kotlin/jvm/functions/Function2.html">Function2</a>&lt;T,&nbsp;T,&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;R&gt;&gt;&nbsp;generator<br>)</code></div>
<p>Returns a <code><a href="/reference/androidx/paging/PagingData.html">PagingData</a></code> containing each original element, with an optional separator generated by <code><a href="/reference/androidx/paging/rxjava3/package-summary.html#generator()">generator</a></code>, given the elements before and after (or null, in boundary conditions).</p>
</td>
</tr>
<tr>
<td><code>static&nbsp;final <a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;R&gt;</code></td>
<td width="100%">
<div><code>&lt;T&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>,&nbsp;R&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/rxjava3/RxPagingDataKt.html#map(androidx.paging.PagingData,kotlin.Function1)">map</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/kotlin/jvm/functions/Function1.html">Function1</a>&lt;T,&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;R&gt;&gt;&nbsp;transform<br>)</code></div>
<p>Returns a <code><a href="/reference/androidx/paging/PagingData.html">PagingData</a></code> containing the result of applying the given <code><a href="/reference/androidx/paging/rxjava3/package-summary.html#transform()">transform</a></code> to each element, as it is loaded.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public methods</h2>
<div><a name="filter(androidx.paging.PagingData, kotlin.Function1)"></a><a name="filter-androidx.paging.PagingData-kotlin.Function1-"></a>
<h3 class="api-name" id="filter(androidx.paging.PagingData,kotlin.Function1)">filter</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a><br>public&nbsp;static&nbsp;final&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;&nbsp;&lt;T&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/rxjava3/RxPagingDataKt.html#filter(androidx.paging.PagingData,kotlin.Function1)">filter</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/kotlin/jvm/functions/Function1.html">Function1</a>&lt;T,&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/java/lang/Boolean.html">Boolean</a>&gt;&gt;&nbsp;predicate<br>)</pre>
<p>Returns a <code><a href="/reference/androidx/paging/PagingData.html">PagingData</a></code> containing only elements matching the given <code><a href="/reference/androidx/paging/rxjava3/package-summary.html#predicate()">predicate</a></code>.</p>
</div>
<div><a name="flatMap(androidx.paging.PagingData, kotlin.Function1)"></a><a name="flatMap-androidx.paging.PagingData-kotlin.Function1-"></a>
<h3 class="api-name" id="flatMap(androidx.paging.PagingData,kotlin.Function1)">flatMap</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a><br>public&nbsp;static&nbsp;final&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;R&gt;&nbsp;&lt;T&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>,&nbsp;R&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/rxjava3/RxPagingDataKt.html#flatMap(androidx.paging.PagingData,kotlin.Function1)">flatMap</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/kotlin/jvm/functions/Function1.html">Function1</a>&lt;T,&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/java/lang/Iterable.html">Iterable</a>&lt;R&gt;&gt;&gt;&nbsp;transform<br>)</pre>
<p>Returns a <code><a href="/reference/androidx/paging/PagingData.html">PagingData</a></code> of all elements returned from applying the given <code><a href="/reference/androidx/paging/rxjava3/package-summary.html#transform()">transform</a></code> to each element, as it is loaded.</p>
</div>
<div><a name="insertSeparators(androidx.paging.PagingData, kotlin.Function2)"></a><a name="insertSeparators-androidx.paging.PagingData-kotlin.Function2-"></a>
<h3 class="api-name" id="insertSeparators(androidx.paging.PagingData,kotlin.Function2)">insertSeparators</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a><br>public&nbsp;static&nbsp;final&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;R&gt;&nbsp;&lt;T&nbsp;extends&nbsp;R,&nbsp;R&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/rxjava3/RxPagingDataKt.html#insertSeparators(androidx.paging.PagingData,kotlin.Function2)">insertSeparators</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/kotlin/jvm/functions/Function2.html">Function2</a>&lt;T,&nbsp;T,&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;R&gt;&gt;&nbsp;generator<br>)</pre>
<p>Returns a <code><a href="/reference/androidx/paging/PagingData.html">PagingData</a></code> containing each original element, with an optional separator generated by <code><a href="/reference/androidx/paging/rxjava3/package-summary.html#generator()">generator</a></code>, given the elements before and after (or null, in boundary conditions).</p>
<p>Note that this transform is applied asynchronously, as pages are loaded. Potential separators between pages are only computed once both pages are loaded.</p>
</div>
<div><a name="map(androidx.paging.PagingData, kotlin.Function1)"></a><a name="map-androidx.paging.PagingData-kotlin.Function1-"></a>
<h3 class="api-name" id="map(androidx.paging.PagingData,kotlin.Function1)">map</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a><br>public&nbsp;static&nbsp;final&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;R&gt;&nbsp;&lt;T&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>,&nbsp;R&nbsp;extends&nbsp;<a href="/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/rxjava3/RxPagingDataKt.html#map(androidx.paging.PagingData,kotlin.Function1)">map</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagingData.html">PagingData</a>&lt;T&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/kotlin/jvm/functions/Function1.html">Function1</a>&lt;T,&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;R&gt;&gt;&nbsp;transform<br>)</pre>
<p>Returns a <code><a href="/reference/androidx/paging/PagingData.html">PagingData</a></code> containing the result of applying the given <code><a href="/reference/androidx/paging/rxjava3/package-summary.html#transform()">transform</a></code> to each element, as it is loaded.</p>
</div>
</body>
</html>