Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes by GitHub action #369

Merged
merged 1 commit into from
Jan 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
425 changes: 425 additions & 0 deletions docs/api/MASES.KNet.Streams.State.CommonIterator-1.html

Large diffs are not rendered by default.

76 changes: 64 additions & 12 deletions docs/api/MASES.KNet.Streams.State.KNetKeyValueIterator-2.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>

<h1 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2" class="text-break">
Class KNetKeyValueIterator&lt;TKey, TValue&gt;
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L32"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L34"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand All @@ -101,7 +101,7 @@ <h1 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2" data-uid="MASES.KNet.St
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class KNetKeyValueIterator&lt;TKey, TValue&gt; : IGenericSerDesFactoryApplier</code></pre>
<pre><code class="lang-csharp hljs">public sealed class KNetKeyValueIterator&lt;TKey, TValue&gt; : CommonIterator&lt;KNetKeyValue&lt;TKey, TValue&gt;&gt;, IGenericSerDesFactoryApplier, IEnumerable&lt;KNetKeyValue&lt;TKey, TValue&gt;&gt;, IEnumerable, IAsyncEnumerable&lt;KNetKeyValue&lt;TKey, TValue&gt;&gt;</code></pre>
</div>


Expand All @@ -120,6 +120,7 @@ <h4 class="section">Type Parameters</h4>
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><a class="xref" href="MASES.KNet.Streams.State.CommonIterator-1.html">CommonIterator</a>&lt;<a class="xref" href="MASES.KNet.Streams.KNetKeyValue-2.html">KNetKeyValue</a>&lt;TKey, TValue&gt;&gt;</div>
<div><span class="xref">KNetKeyValueIterator&lt;TKey, TValue&gt;</span></div>
</dd>
</dl>
Expand All @@ -128,13 +129,25 @@ <h4 class="section">Type Parameters</h4>
<dt>Implements</dt>
<dd>
<div><a class="xref" href="MASES.KNet.Serialization.IGenericSerDesFactoryApplier.html">IGenericSerDesFactoryApplier</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="MASES.KNet.Streams.KNetKeyValue-2.html">KNetKeyValue</a>&lt;TKey, TValue&gt;&gt;</div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerable">IEnumerable</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerable-1">IAsyncEnumerable</a>&lt;<a class="xref" href="MASES.KNet.Streams.KNetKeyValue-2.html">KNetKeyValue</a>&lt;TKey, TValue&gt;&gt;</div>
</dd>
</dl>


<dl class="typelist derived">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="MASES.KNet.Streams.State.CommonIterator-1.html#MASES_KNet_Streams_State_CommonIterator_1_UsePrefetch">CommonIterator&lt;KNetKeyValue&lt;TKey, TValue&gt;&gt;.UsePrefetch</a>
</div>
<div>
<a class="xref" href="MASES.KNet.Streams.State.CommonIterator-1.html#MASES_KNet_Streams_State_CommonIterator_1_GetEnumerator">CommonIterator&lt;KNetKeyValue&lt;TKey, TValue&gt;&gt;.GetEnumerator()</a>
</div>
<div>
<a class="xref" href="MASES.KNet.Streams.State.CommonIterator-1.html#MASES_KNet_Streams_State_CommonIterator_1_GetAsyncEnumerator_System_Threading_CancellationToken_">CommonIterator&lt;KNetKeyValue&lt;TKey, TValue&gt;&gt;.GetAsyncEnumerator(CancellationToken)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
Expand All @@ -153,9 +166,6 @@ <h4 class="section">Type Parameters</h4>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
</dd></dl>


Expand All @@ -171,7 +181,7 @@ <h2 class="section" id="properties">Properties

<h3 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_HasNext" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2.HasNext">
HasNext
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L134"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L172"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>KNet implementation of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html#hasNext()">https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html#hasNext()</a></p>
Expand Down Expand Up @@ -203,7 +213,7 @@ <h4 class="section">Property Value</h4>

<h3 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_Next" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2.Next">
Next
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L138"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L176"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>KNet implementation of <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html#next()">https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html#next()</a></p>
Expand Down Expand Up @@ -235,7 +245,7 @@ <h4 class="section">Property Value</h4>

<h3 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_PeekNextKey" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2.PeekNextKey">
PeekNextKey
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L179"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L208"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>KNet implementation of <a href="https://www.javadoc.io/doc/org.apache.kafka/kafka-streams/3.6.1/org/apache/kafka/streams/state/KeyValueIterator.html#peekNextKey--">https://www.javadoc.io/doc/org.apache.kafka/kafka-streams/3.6.1/org/apache/kafka/streams/state/KeyValueIterator.html#peekNextKey--</a></p>
Expand Down Expand Up @@ -272,7 +282,7 @@ <h2 class="section" id="methods">Methods

<h3 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_Close" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2.Close">
Close()
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L192"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L221"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>KNet implementation of <a href="https://www.javadoc.io/doc/org.apache.kafka/kafka-streams/3.6.1/org/apache/kafka/streams/state/KeyValueIterator.html#close--">https://www.javadoc.io/doc/org.apache.kafka/kafka-streams/3.6.1/org/apache/kafka/streams/state/KeyValueIterator.html#close--</a></p>
Expand All @@ -295,11 +305,53 @@ <h3 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_Close" data-uid="MASES.K



<a id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_GetEnumerator_" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2.GetEnumerator*"></a>

<h3 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_GetEnumerator_System_Boolean_System_Threading_CancellationToken_" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2.GetEnumerator(System.Boolean,System.Threading.CancellationToken)">
GetEnumerator(bool, CancellationToken)
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L154"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Internally gets the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable&lt;T&gt;</a> or <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerable-1">IAsyncEnumerable&lt;T&gt;</a></p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected override object GetEnumerator(bool isAsync, CancellationToken cancellationToken = default)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>isAsync</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>If requesting an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerator-1">IAsyncEnumerator&lt;T&gt;</a></p>
</dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a> to be used in <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerator-1">IAsyncEnumerator&lt;T&gt;</a></p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable&lt;T&gt;</a> or <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iasyncenumerable-1">IAsyncEnumerable&lt;T&gt;</a></p>
</dd>
</dl>











<a id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_Remove_" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2.Remove*"></a>

<h3 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_Remove" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2.Remove">
Remove()
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L151"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L189"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html#remove()">https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html#remove()</a></p>
Expand All @@ -326,7 +378,7 @@ <h3 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_Remove" data-uid="MASES.

<h3 id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_ToIEnumerator_System_Boolean_" data-uid="MASES.KNet.Streams.State.KNetKeyValueIterator`2.ToIEnumerator(System.Boolean)">
ToIEnumerator(bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L161"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L199"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Returns an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerator-1">IEnumerator&lt;T&gt;</a> of <a class="xref" href="MASES.KNet.Streams.KNetKeyValue-2.html">KNetKeyValue&lt;TKey, TValue&gt;</a></p>
Expand Down Expand Up @@ -368,7 +420,7 @@ <h4 class="section" id="MASES_KNet_Streams_State_KNetKeyValueIterator_2_ToIEnume
</article>

<div class="contribution d-print-none">
<a href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L32" class="edit-link">Edit this page</a>
<a href="https://github.com/masesgroup/KNet/blob/master/src/net/KNet/Specific/Streams/State/KNetKeyValueIterator.cs/#L34" class="edit-link">Edit this page</a>
</div>


Expand Down
Loading