This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new b41a6078 update documentation for tag main
b41a6078 is described below
commit b41a60780ba1d81000eac8a37aaa6f9be4632038
Author: GitHub Actions <[email protected]>
AuthorDate: Fri Dec 27 02:02:49 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1519227 -> 1554169 bytes
main/.doctrees/reference/ipc.doctree | Bin 374302 -> 430909 bytes
main/genindex.html | 26 +++++++++-
main/objects.inv | Bin 25071 -> 25491 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 94 +++++++++++++++++++++++++++++++++++
main/searchindex.js | 2 +-
7 files changed, 120 insertions(+), 4 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 6e11a264..1f767cb7 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/reference/ipc.doctree
b/main/.doctrees/reference/ipc.doctree
index c1709f44..f95e7cb4 100644
Binary files a/main/.doctrees/reference/ipc.doctree and
b/main/.doctrees/reference/ipc.doctree differ
diff --git a/main/genindex.html b/main/genindex.html
index 463740b0..08847b0c 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -836,8 +836,6 @@
</li>
<li><a
href="reference/device.html#_CPPv435ArrowDeviceArrayViewSetArrayMinimalP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">ArrowDeviceArrayViewSetArrayMinimal
(C++ function)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv431ArrowDeviceBasicArrayStreamInitP22ArrowDeviceArrayStreamP16ArrowArrayStreamP11ArrowDevice">ArrowDeviceBasicArrayStreamInit
(C++ function)</a>
</li>
<li><a
href="reference/device.html#_CPPv421ArrowDeviceBufferCopyP11ArrowDevice15ArrowBufferViewP11ArrowDevice15ArrowBufferView">ArrowDeviceBufferCopy
(C++ function)</a>
@@ -848,6 +846,8 @@
</li>
<li><a
href="reference/device.html#_CPPv426ArrowDeviceBufferInitAsyncP11ArrowDevice15ArrowBufferViewP11ArrowDeviceP11ArrowBufferPv">ArrowDeviceBufferInitAsync
(C++ function)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv421ArrowDeviceBufferMoveP11ArrowDeviceP11ArrowBufferP11ArrowDeviceP11ArrowBuffer">ArrowDeviceBufferMove
(C++ function)</a>
</li>
<li><a
href="reference/device.html#_CPPv423ArrowDeviceCheckRuntimeP10ArrowError">ArrowDeviceCheckRuntime
(C++ function)</a>
@@ -947,12 +947,26 @@
<li><a
href="reference/ipc.html#_CPPv425ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError">ArrowIpcDecoderPeekHeader
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv420ArrowIpcDecoderResetP15ArrowIpcDecoder">ArrowIpcDecoderReset
(C++ function)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv430ArrowIpcDecoderSetDecompressorP15ArrowIpcDecoderP20ArrowIpcDecompressor">ArrowIpcDecoderSetDecompressor
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv428ArrowIpcDecoderSetEndiannessP15ArrowIpcDecoder18ArrowIpcEndianness">ArrowIpcDecoderSetEndianness
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv424ArrowIpcDecoderSetSchemaP15ArrowIpcDecoderP11ArrowSchemaP10ArrowError">ArrowIpcDecoderSetSchema
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv427ArrowIpcDecoderVerifyHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError">ArrowIpcDecoderVerifyHeader
(C++ function)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv426ArrowIpcDecompressFunction">ArrowIpcDecompressFunction
(C++ type)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv420ArrowIpcDecompressor">ArrowIpcDecompressor
(C++ struct)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N20ArrowIpcDecompressor14decompress_addE">ArrowIpcDecompressor::decompress_add
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N20ArrowIpcDecompressor15decompress_waitE">ArrowIpcDecompressor::decompress_wait
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N20ArrowIpcDecompressor12private_dataE">ArrowIpcDecompressor::private_data
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N20ArrowIpcDecompressor7releaseE">ArrowIpcDecompressor::release
(C++ member)</a>
</li>
<li><a href="reference/ipc.html#_CPPv415ArrowIpcEncoder">ArrowIpcEncoder
(C++ struct)</a>
</li>
@@ -975,6 +989,8 @@
<li><a
href="reference/ipc.html#_CPPv4N18ArrowIpcEndianness31NANOARROW_IPC_ENDIANNESS_LITTLEE">ArrowIpcEndianness::NANOARROW_IPC_ENDIANNESS_LITTLE
(C++ enumerator)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N18ArrowIpcEndianness38NANOARROW_IPC_ENDIANNESS_UNINITIALIZEDE">ArrowIpcEndianness::NANOARROW_IPC_ENDIANNESS_UNINITIALIZED
(C++ enumerator)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv436ArrowIpcGetZstdDecompressionFunctionv">ArrowIpcGetZstdDecompressionFunction
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv419ArrowIpcInputStream">ArrowIpcInputStream (C++
struct)</a>
</li>
@@ -1031,6 +1047,10 @@
<li><a
href="reference/ipc.html#_CPPv424ArrowIpcOutputStreamMoveP20ArrowIpcOutputStreamP20ArrowIpcOutputStream">ArrowIpcOutputStreamMove
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv425ArrowIpcOutputStreamWriteP20ArrowIpcOutputStream15ArrowBufferViewP10ArrowError">ArrowIpcOutputStreamWrite
(C++ function)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv426ArrowIpcSerialDecompressorP20ArrowIpcDecompressor">ArrowIpcSerialDecompressor
(C++ function)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv437ArrowIpcSerialDecompressorSetFunctionP20ArrowIpcDecompressor23ArrowIpcCompressionType26ArrowIpcDecompressFunction">ArrowIpcSerialDecompressorSetFunction
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv420ArrowIpcSharedBuffer">ArrowIpcSharedBuffer
(C++ struct)</a>
</li>
@@ -1829,6 +1849,8 @@
<li><a href="reference/cpp.html#_CPPv412UniqueBuffer">UniqueBuffer (C++
type)</a>
</li>
<li><a href="reference/ipc.html#_CPPv413UniqueDecoder">UniqueDecoder
(C++ type)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv418UniqueDecompressor">UniqueDecompressor (C++
type)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
diff --git a/main/objects.inv b/main/objects.inv
index c51a1a23..c73b0c4c 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 806cc31e..3d2dfb8d 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2024-12-17T03:16Z
+last_built: 2024-12-27T02:02Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index 74b0ead6..126a5cb0 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -398,6 +398,16 @@
<dd><p>Feature flag for a stream that uses compression. </p>
</dd></dl>
+</div>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-typedefs">Typedefs</p>
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv426ArrowIpcDecompressFunction">
+<span id="_CPPv326ArrowIpcDecompressFunction"></span><span
id="_CPPv226ArrowIpcDecompressFunction"></span><span
id="ArrowIpcDecompressFunction"></span><span class="target"
id="group__nanoarrow__ipc_1ga74ed8ec651ecc43c0de70f4a9b556571"></span><span
class="k"><span class="pre">typedef</span></span><span class="w"> </span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w" [...]
+<dd><p>A self-contained decompression function. </p>
+<p>For the most common compression type, ZSTD, this function is sufficient to
capture the type of decompression that Arrow IPC requires (i.e., decompression
where the uncompressed size was recorded). For other compression types, it may
be more efficient to implement a full <a class="reference internal"
href="#struct_arrow_ipc_decompressor"><span class="std
std-ref">ArrowIpcDecompressor</span></a>, which allows for persistent
state/allocations between decodes. </p>
+</dd></dl>
+
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-enums">Enums</p>
@@ -550,6 +560,26 @@
<p>Thread-safe shared buffers require C11 and the stdatomic.h header. If
either are unavailable, shared buffers are still possible but the resulting
arrays must not be passed to other threads to be released. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv436ArrowIpcGetZstdDecompressionFunctionv">
+<span id="_CPPv336ArrowIpcGetZstdDecompressionFunctionv"></span><span
id="_CPPv236ArrowIpcGetZstdDecompressionFunctionv"></span><span
id="ArrowIpcGetZstdDecompressionFunction__void"></span><span class="target"
id="group__nanoarrow__ipc_1ga3e3219be4d2843651e62bc41c338fbec"></span><a
class="reference internal" href="#_CPPv426ArrowIpcDecompressFunction"
title="ArrowIpcDecompressFunction"><span class="n"><span
class="pre">ArrowIpcDecompressFunction</span></span></a><span class="w">
</span><s [...]
+<dd><p>Get the decompression function for ZSTD. </p>
+<p>The result will be NULL if nanoarrow was not built with
NANOARROW_IPC_WITH_ZSTD. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv426ArrowIpcSerialDecompressorP20ArrowIpcDecompressor">
+<span
id="_CPPv326ArrowIpcSerialDecompressorP20ArrowIpcDecompressor"></span><span
id="_CPPv226ArrowIpcSerialDecompressorP20ArrowIpcDecompressor"></span><span
id="ArrowIpcSerialDecompressor__ArrowIpcDecompressorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga60837b7aa9f377dc037d2cffc34c5b6f"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span>< [...]
+<dd><p>An <a class="reference internal"
href="#struct_arrow_ipc_decompressor"><span class="std
std-ref">ArrowIpcDecompressor</span></a> implementation that performs
decompression in serial. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv437ArrowIpcSerialDecompressorSetFunctionP20ArrowIpcDecompressor23ArrowIpcCompressionType26ArrowIpcDecompressFunction">
+<span
id="_CPPv337ArrowIpcSerialDecompressorSetFunctionP20ArrowIpcDecompressor23ArrowIpcCompressionType26ArrowIpcDecompressFunction"></span><span
id="_CPPv237ArrowIpcSerialDecompressorSetFunctionP20ArrowIpcDecompressor23ArrowIpcCompressionType26ArrowIpcDecompressFunction"></span><span
id="ArrowIpcSerialDecompressorSetFunction__ArrowIpcDecompressorP.ArrowIpcCompressionType.ArrowIpcDecompressFunction"></span><span
class="target" id="group__nanoarrow__ipc_1ga941eeedd1156c97cb156238c188316d2
[...]
+<dd><p>Override the ArrowIpcDecompressFunction used for a specific compression
type. </p>
+<p>This may be used to inject support for a particular type of decompression
if used with a version of nanoarrow with unknown or minimal capabilities. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv419ArrowIpcDecoderInitP15ArrowIpcDecoder">
<span id="_CPPv319ArrowIpcDecoderInitP15ArrowIpcDecoder"></span><span
id="_CPPv219ArrowIpcDecoderInitP15ArrowIpcDecoder"></span><span
id="ArrowIpcDecoderInit__ArrowIpcDecoderP"></span><span class="target"
id="group__nanoarrow__ipc_1ga0a0b859bb7e01fc0a0828233f959492e"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><span
class="sig-name descname"><span [...]
@@ -562,6 +592,12 @@
<dd><p>Release all resources attached to a decoder. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv430ArrowIpcDecoderSetDecompressorP15ArrowIpcDecoderP20ArrowIpcDecompressor">
+<span
id="_CPPv330ArrowIpcDecoderSetDecompressorP15ArrowIpcDecoderP20ArrowIpcDecompressor"></span><span
id="_CPPv230ArrowIpcDecoderSetDecompressorP15ArrowIpcDecoderP20ArrowIpcDecompressor"></span><span
id="ArrowIpcDecoderSetDecompressor__ArrowIpcDecoderP.ArrowIpcDecompressorP"></span><span
class="target"
id="group__nanoarrow__ipc_1gace9dc45bb1cdf213e4a9670305d06eca"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span clas [...]
+<dd><p>Set the decompressor implementation used by this decoder. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv425ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError">
<span
id="_CPPv325ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError"></span><span
id="_CPPv225ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError"></span><span
id="ArrowIpcDecoderPeekHeader__ArrowIpcDecoderP.ArrowBufferView.int32_tP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga83e3c2c6e3da406bc1f45b5b81eee5f5"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowError [...]
@@ -781,6 +817,45 @@
<p>A structure representing a reference-counted buffer that may be passed to
<a class="reference internal"
href="#group__nanoarrow__ipc_1gaec39d82c6e5b112457e5adf42d0fd9d7"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayFromShared()</span></a>. </p>
</dd></dl>
+<dl class="cpp struct">
+<dt class="sig sig-object cpp" id="_CPPv420ArrowIpcDecompressor">
+<span id="_CPPv320ArrowIpcDecompressor"></span><span
id="_CPPv220ArrowIpcDecompressor"></span><span
id="ArrowIpcDecompressor"></span><span class="target"
id="struct_arrow_ipc_decompressor"></span><span class="k"><span
class="pre">struct</span></span><span class="w"> </span><span class="sig-name
descname"><span class="n"><span
class="pre">ArrowIpcDecompressor</span></span></span><a class="headerlink"
href="#_CPPv420ArrowIpcDecompressor" title="Link to this definition">#</a><br
/></dt>
+<dd><div class="docutils container">
+<em>#include <nanoarrow_ipc.h></em></div>
+<p>A user-extensible decompressor. </p>
+<p>The <a class="reference internal"
href="#struct_arrow_ipc_decompressor"><span class="std
std-ref">ArrowIpcDecompressor</span></a> is the underlying object that enables
decompression in the <a class="reference internal"
href="#struct_arrow_ipc_decoder"><span class="std
std-ref">ArrowIpcDecoder</span></a>. Its structure allows it to be backed by a
multithreaded implementation; however, this is not required and the default
implementation does not implement this. An implementation of a de [...]
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-public-members">Public Members</p>
+<dl class="cpp var">
+<dt class="sig sig-object cpp"
id="_CPPv4N20ArrowIpcDecompressor14decompress_addE">
+<span id="_CPPv3N20ArrowIpcDecompressor14decompress_addE"></span><span
id="_CPPv2N20ArrowIpcDecompressor14decompress_addE"></span><span class="target"
id="struct_arrow_ipc_decompressor_1a9abf49223bbbb1972b116996120a6ed6"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><span
class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*
[...]
+<dd><p>Queue a buffer for decompression. </p>
+<p>The values pointed to by dst and dst_size after a call to decompress_add
are undefined until the next call to decompress_wait returns NANOARROW_OK. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp"
id="_CPPv4N20ArrowIpcDecompressor15decompress_waitE">
+<span id="_CPPv3N20ArrowIpcDecompressor15decompress_waitE"></span><span
id="_CPPv2N20ArrowIpcDecompressor15decompress_waitE"></span><span
class="target"
id="struct_arrow_ipc_decompressor_1a8131bfb5d4ece03949c706c2b71e3337"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><span
class="p"><span class="pre">(</span></span><span class="p"><span class="pre"
[...]
+<dd><p>Wait for any unfinished calls to decompress_add to complete. </p>
+<p>Returns NANOARROW_OK if all pending calls completed. Returns ETIMEOUT if
not all remaining calls completed. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N20ArrowIpcDecompressor7releaseE">
+<span id="_CPPv3N20ArrowIpcDecompressor7releaseE"></span><span
id="_CPPv2N20ArrowIpcDecompressor7releaseE"></span><span class="target"
id="struct_arrow_ipc_decompressor_1a1fff139d893c876b8c16b624bf6692fd"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">(</span></span><span class="p"><span
class="pre">*</span></span><span class="sig-name descname"><span
class="n"><span class="pre">release</span></span></span><span class [...]
+<dd><p>Release the decompressor and any resources it may be holding. </p>
+<p>Release callback implementations must set the release member to NULL.
Callers must check that the release callback is not NULL before calling
decompress() or <a class="reference internal"
href="#struct_arrow_ipc_decompressor_1a1fff139d893c876b8c16b624bf6692fd"><span
class="std std-ref">release()</span></a>. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp"
id="_CPPv4N20ArrowIpcDecompressor12private_dataE">
+<span id="_CPPv3N20ArrowIpcDecompressor12private_dataE"></span><span
id="_CPPv2N20ArrowIpcDecompressor12private_dataE"></span><span
id="ArrowIpcDecompressor::private_data__voidP"></span><span class="target"
id="struct_arrow_ipc_decompressor_1a5fcd3442cdede3710ebed7a4e512019b"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span class="pre">private_data</sp [...]
+<dd><p>Implementation-specific opaque data. </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv415ArrowIpcDecoder">
<span id="_CPPv315ArrowIpcDecoder"></span><span
id="_CPPv215ArrowIpcDecoder"></span><span id="ArrowIpcDecoder"></span><span
class="target" id="struct_arrow_ipc_decoder"></span><span class="k"><span
class="pre">struct</span></span><span class="w"> </span><span class="sig-name
descname"><span class="n"><span
class="pre">ArrowIpcDecoder</span></span></span><a class="headerlink"
href="#_CPPv415ArrowIpcDecoder" title="Link to this definition">#</a><br /></dt>
@@ -1004,6 +1079,12 @@
<dd><p>Class wrapping a unique struct <a class="reference internal"
href="#struct_arrow_ipc_encoder"><span class="std
std-ref">ArrowIpcEncoder</span></a>. </p>
</dd></dl>
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv418UniqueDecompressor">
+<span id="_CPPv318UniqueDecompressor"></span><span
id="_CPPv218UniqueDecompressor"></span><span class="target"
id="group__nanoarrow__ipc__hpp-unique_1gaba25494dc1e52ad34fa4365f35e0fb9f"></span><span
class="k"><span class="pre">using</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">UniqueDecompressor</span></span></span><span class="w">
</span><span class="p"><span class="pre">=</span></span><span class="w">
</span><span class="n"><spa [...]
+<dd><p>Class wrapping a unique struct <a class="reference internal"
href="#struct_arrow_ipc_decompressor"><span class="std
std-ref">ArrowIpcDecompressor</span></a>. </p>
+</dd></dl>
+
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv417UniqueInputStream">
<span id="_CPPv317UniqueInputStream"></span><span
id="_CPPv217UniqueInputStream"></span><span class="target"
id="group__nanoarrow__ipc__hpp-unique_1ga01cded4704dc447650624c061d1fe5db"></span><span
class="k"><span class="pre">using</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">UniqueInputStream</span></span></span><span class="w"> </span><span
class="p"><span class="pre">=</span></span><span class="w"> </span><span
class="n"><span c [...]
@@ -1076,6 +1157,7 @@
<nav class="bd-toc-nav page-toc"
aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#c-api">C API</a><ul class="visible nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv426ArrowIpcDecompressFunction"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDecompressFunction</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv423ArrowIpcMetadataVersion"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcMetadataVersion</span></code></a><ul
class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N23ArrowIpcMetadataVersion33NANOARROW_IPC_METADATA_VERSION_V1E"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcMetadataVersion::NANOARROW_IPC_METADATA_VERSION_V1</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N23ArrowIpcMetadataVersion33NANOARROW_IPC_METADATA_VERSION_V2E"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcMetadataVersion::NANOARROW_IPC_METADATA_VERSION_V2</span></code></a></li>
@@ -1110,8 +1192,12 @@
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv424ArrowIpcSharedBufferInitP20ArrowIpcSharedBufferP11ArrowBuffer"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcSharedBufferInit()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv425ArrowIpcSharedBufferResetP20ArrowIpcSharedBuffer"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcSharedBufferReset()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv432ArrowIpcSharedBufferIsThreadSafev"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcSharedBufferIsThreadSafe()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv436ArrowIpcGetZstdDecompressionFunctionv"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcGetZstdDecompressionFunction()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv426ArrowIpcSerialDecompressorP20ArrowIpcDecompressor"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcSerialDecompressor()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv437ArrowIpcSerialDecompressorSetFunctionP20ArrowIpcDecompressor23ArrowIpcCompressionType26ArrowIpcDecompressFunction"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcSerialDecompressorSetFunction()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv419ArrowIpcDecoderInitP15ArrowIpcDecoder"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcDecoderInit()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcDecoderResetP15ArrowIpcDecoder"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcDecoderReset()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv430ArrowIpcDecoderSetDecompressorP15ArrowIpcDecoderP20ArrowIpcDecompressor"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcDecoderSetDecompressor()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv425ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcDecoderPeekHeader()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowIpcDecoderVerifyHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcDecoderVerifyHeader()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowIpcDecoderDecodeHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcDecoderDecodeHeader()</span></code></a></li>
@@ -1142,6 +1228,13 @@
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv423ArrowIpcWriterStartFileP14ArrowIpcWriterP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcWriterStartFile()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv426ArrowIpcWriterFinalizeFileP14ArrowIpcWriterP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcWriterFinalizeFile()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcSharedBuffer"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcSharedBuffer</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcDecompressor"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDecompressor</span></code></a><ul
class="nav section-nav flex-column">
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N20ArrowIpcDecompressor14decompress_addE"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcDecompressor::decompress_add</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N20ArrowIpcDecompressor15decompress_waitE"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcDecompressor::decompress_wait</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N20ArrowIpcDecompressor7releaseE"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcDecompressor::release</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N20ArrowIpcDecompressor12private_dataE"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcDecompressor::private_data</span></code></a></li>
+</ul>
+</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv415ArrowIpcDecoder"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDecoder</span></code></a><ul class="nav
section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcDecoder12message_typeE"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcDecoder::message_type</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcDecoder16metadata_versionE"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcDecoder::metadata_version</span></code></a></li>
@@ -1185,6 +1278,7 @@
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv413UniqueDecoder"><code class="docutils literal notranslate"><span
class="pre">UniqueDecoder</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv412UniqueFooter"><code class="docutils literal notranslate"><span
class="pre">UniqueFooter</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv413UniqueEncoder"><code class="docutils literal notranslate"><span
class="pre">UniqueEncoder</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv418UniqueDecompressor"><code class="docutils literal
notranslate"><span class="pre">UniqueDecompressor</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv417UniqueInputStream"><code class="docutils literal
notranslate"><span class="pre">UniqueInputStream</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv418UniqueOutputStream"><code class="docutils literal
notranslate"><span class="pre">UniqueOutputStream</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv412UniqueWriter"><code class="docutils literal notranslate"><span
class="pre">UniqueWriter</span></code></a></li>
diff --git a/main/searchindex.js b/main/searchindex.js
index 02060f3c..9b280f4c 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[8, null]], "Array Stream
utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[5, "bitmap-
[...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[8, null]], "Array Stream
utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[5, "bitmap-
[...]
\ No newline at end of file
