You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by gi...@apache.org on 2024/06/26 21:13:10 UTC
(arrow-rs) branch asf-site updated: deploy: 0a4d8a14b58e45ef92e31541f0b51a5b25de5f10
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-rs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new d1fd7df0f5a deploy: 0a4d8a14b58e45ef92e31541f0b51a5b25de5f10
d1fd7df0f5a is described below
commit d1fd7df0f5adc033bf7afec040ac148ad397fb97
Author: tustvold <tu...@users.noreply.github.com>
AuthorDate: Wed Jun 26 21:13:06 2024 +0000
deploy: 0a4d8a14b58e45ef92e31541f0b51a5b25de5f10
---
arrow_array/ffi/struct.FFI_ArrowArray.html | 24 +++----
arrow_data/ffi/index.html | 2 +-
arrow_data/ffi/struct.FFI_ArrowArray.html | 26 ++++----
src/arrow_array/ffi.rs.html | 24 +++----
src/arrow_data/ffi.rs.html | 102 ++---------------------------
5 files changed, 42 insertions(+), 136 deletions(-)
diff --git a/arrow_array/ffi/struct.FFI_ArrowArray.html b/arrow_array/ffi/struct.FFI_ArrowArray.html
index 39e9f0ec0e8..b1c18ab7416 100644
--- a/arrow_array/ffi/struct.FFI_ArrowArray.html
+++ b/arrow_array/ffi/struct.FFI_ArrowArray.html
@@ -16,7 +16,7 @@ See <a href="https://arrow.apache.org/docs/format/CDataInterface.html#structure-
FFI_ArrowArray::new(array)
}</code></pre></div>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.length" class="structfield section-header"><a href="#structfield.length" class="anchor field">§</a><code>length: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></span><span id="structfield.null_count" class="structfield section-header"><a href="#structfield.null_count" class="anchor field">§</a><code>null_ [...]
-</div></details><details class="toggle method-toggle" open><summary><section id="method.from_raw" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#259">source</a><h4 class="code-header">pub unsafe fn <a href="#method.from_raw" class="fn">from_raw</a>(array: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_array::ffi::FFI_ArrowArray">FFI_Ar [...]
+</div></details><details class="toggle method-toggle" open><summary><section id="method.from_raw" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#212">source</a><h4 class="code-header">pub unsafe fn <a href="#method.from_raw" class="fn">from_raw</a>(array: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_array::ffi::FFI_ArrowArray">FFI_Ar [...]
<p>This acts to <a href="https://arrow.apache.org/docs/format/CDataInterface.html#moving-an-array">move</a> the data out of <code>array</code>, setting the release callback to NULL</p>
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
<ul>
@@ -24,19 +24,19 @@ See <a href="https://arrow.apache.org/docs/format/CDataInterface.html#structure-
<li><code>array</code> must be properly aligned</li>
<li><code>array</code> must point to a properly initialized value of <a href="struct.FFI_ArrowArray.html" title="struct arrow_array::ffi::FFI_ArrowArray"><code>FFI_ArrowArray</code></a></li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.empty" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#264">source</a><h4 class="code-header">pub fn <a href="#method.empty" class="fn">empty</a>() -> <a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_array::ffi::FFI_ArrowArray">FFI_ArrowArray</a></h4></section></summary><div class="docblock"><p>create an empty <code>FFI_ArrowArray</code>, which [...]
-</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#281">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the length of the array</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#287">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>whether the array is empty</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.is_released" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#293">source</a><h4 class="code-header">pub fn <a href="#method.is_released" class="fn">is_released</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Whether the array has been released</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.offset" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#299">source</a><h4 class="code-header">pub fn <a href="#method.offset" class="fn">offset</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the offset of the array</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.null_count" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#305">source</a><h4 class="code-header">pub fn <a href="#method.null_count" class="fn">null_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the null count of the array</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.buffer" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#314">source</a><h4 class="code-header">pub fn <a href="#method.buffer" class="fn">buffer</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a [...]
+</div></details><details class="toggle method-toggle" open><summary><section id="method.empty" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#217">source</a><h4 class="code-header">pub fn <a href="#method.empty" class="fn">empty</a>() -> <a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_array::ffi::FFI_ArrowArray">FFI_ArrowArray</a></h4></section></summary><div class="docblock"><p>create an empty <code>FFI_ArrowArray</code>, which [...]
+</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#234">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the length of the array</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#240">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>whether the array is empty</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.is_released" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#246">source</a><h4 class="code-header">pub fn <a href="#method.is_released" class="fn">is_released</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Whether the array has been released</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.offset" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#252">source</a><h4 class="code-header">pub fn <a href="#method.offset" class="fn">offset</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the offset of the array</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.null_count" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#258">source</a><h4 class="code-header">pub fn <a href="#method.null_count" class="fn">null_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the null count of the array</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.buffer" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#267">source</a><h4 class="code-header">pub fn <a href="#method.buffer" class="fn">buffer</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a [...]
<h5 id="panic"><a class="doc-anchor" href="#panic">§</a>Panic</h5>
<p>Panics if index exceeds the number of buffers or the buffer is not correctly aligned</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.num_buffers" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#324">source</a><h4 class="code-header">pub fn <a href="#method.num_buffers" class="fn">num_buffers</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of buffers</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.child" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#330">source</a><h4 class="code-header">pub fn <a href="#method.child" class="fn">child</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &<a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_array::ffi::FFI_ArrowArray"> [...]
-</div></details><details class="toggle method-toggle" open><summary><section id="method.num_children" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#343">source</a><h4 class="code-header">pub fn <a href="#method.num_children" class="fn">num_children</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of children</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.dictionary" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#349">source</a><h4 class="code-header">pub fn <a href="#method.dictionary" class="fn">dictionary</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="struct.FFI_ArrowArray.html" titl [...]
+</div></details><details class="toggle method-toggle" open><summary><section id="method.num_buffers" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#277">source</a><h4 class="code-header">pub fn <a href="#method.num_buffers" class="fn">num_buffers</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of buffers</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.child" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#283">source</a><h4 class="code-header">pub fn <a href="#method.child" class="fn">child</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &<a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_array::ffi::FFI_ArrowArray"> [...]
+</div></details><details class="toggle method-toggle" open><summary><section id="method.num_children" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#296">source</a><h4 class="code-header">pub fn <a href="#method.num_children" class="fn">num_children</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of children</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.dictionary" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#302">source</a><h4 class="code-header">pub fn <a href="#method.dictionary" class="fn">dictionary</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="struct.FFI_ArrowArray.html" titl [...]
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-FFI_ArrowArray" class="impl"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#38">source</a><a href="#impl-Debug-for-FFI_ArrowArray" class="anchor">§</a><h3 class="code-header">impl < [...]
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href [...]
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https:/ [...]
diff --git a/arrow_data/ffi/index.html b/arrow_data/ffi/index.html
index 599f30b700f..5e2f8b13bd4 100644
--- a/arrow_data/ffi/index.html
+++ b/arrow_data/ffi/index.html
@@ -1,3 +1,3 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Contains declarations to bind to the C Data Interface."><title>arrow_data::ffi - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium [...]
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Contains declarations to bind to the C Data Interface."><title>arrow_data::ffi - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium [...]
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ArrayPrivateData.html" title="struct arrow_data::ffi::ArrayPrivateData">ArrayPrivateData</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_data::ffi::FFI_ArrowArray">FFI_ArrowArray</a></div> [...]
See <a href="https://arrow.apache.org/docs/format/CDataInterface.html#structure-definitions">https://arrow.apache.org/docs/format/CDataInterface.html#structure-definitions</a></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.align_nulls.html" title="fn arrow_data::ffi::align_nulls">align_nulls</a><span title="Restricted Visibility"> 🔒</span> </div>< [...]
\ No newline at end of file
diff --git a/arrow_data/ffi/struct.FFI_ArrowArray.html b/arrow_data/ffi/struct.FFI_ArrowArray.html
index 43cdc9e8a1d..1a4b1a75896 100644
--- a/arrow_data/ffi/struct.FFI_ArrowArray.html
+++ b/arrow_data/ffi/struct.FFI_ArrowArray.html
@@ -15,8 +15,8 @@ See <a href="https://arrow.apache.org/docs/format/CDataInterface.html#structure-
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>export_array(array: <span class="kw-2">&</span>ArrayData) -> FFI_ArrowArray {
FFI_ArrowArray::new(array)
}</code></pre></div>
-</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.length" class="structfield section-header"><a href="#structfield.length" class="anchor field">§</a><code>length: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></span><span id="structfield.null_count" class="structfield section-header"><a href="#structfield.null_count" class="anchor field">§</a><code>null_ [...]
-</div></details><details class="toggle method-toggle" open><summary><section id="method.from_raw" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#259-261">source</a><h4 class="code-header">pub unsafe fn <a href="#method.from_raw" class="fn">from_raw</a>(array: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_data::ffi::FFI_ArrowArray">FFI [...]
+</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.length" class="structfield section-header"><a href="#structfield.length" class="anchor field">§</a><code>length: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code></span><span id="structfield.null_count" class="structfield section-header"><a href="#structfield.null_count" class="anchor field">§</a><code>null_ [...]
+</div></details><details class="toggle method-toggle" open><summary><section id="method.from_raw" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#212-214">source</a><h4 class="code-header">pub unsafe fn <a href="#method.from_raw" class="fn">from_raw</a>(array: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_data::ffi::FFI_ArrowArray">FFI [...]
<p>This acts to <a href="https://arrow.apache.org/docs/format/CDataInterface.html#moving-an-array">move</a> the data out of <code>array</code>, setting the release callback to NULL</p>
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
<ul>
@@ -24,19 +24,19 @@ See <a href="https://arrow.apache.org/docs/format/CDataInterface.html#structure-
<li><code>array</code> must be properly aligned</li>
<li><code>array</code> must point to a properly initialized value of <a href="struct.FFI_ArrowArray.html" title="struct arrow_data::ffi::FFI_ArrowArray"><code>FFI_ArrowArray</code></a></li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.empty" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#264-277">source</a><h4 class="code-header">pub fn <a href="#method.empty" class="fn">empty</a>() -> Self</h4></section></summary><div class="docblock"><p>create an empty <code>FFI_ArrowArray</code>, which can be used to import data into</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#281-283">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the length of the array</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#287-289">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>whether the array is empty</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.is_released" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#293-295">source</a><h4 class="code-header">pub fn <a href="#method.is_released" class="fn">is_released</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Whether the array has been released</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.offset" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#299-301">source</a><h4 class="code-header">pub fn <a href="#method.offset" class="fn">offset</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the offset of the array</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.null_count" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#305-307">source</a><h4 class="code-header">pub fn <a href="#method.null_count" class="fn">null_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the null count of the array</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.buffer" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#314-320">source</a><h4 class="code-header">pub fn <a href="#method.buffer" class="fn">buffer</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </ [...]
+</div></details><details class="toggle method-toggle" open><summary><section id="method.empty" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#217-230">source</a><h4 class="code-header">pub fn <a href="#method.empty" class="fn">empty</a>() -> Self</h4></section></summary><div class="docblock"><p>create an empty <code>FFI_ArrowArray</code>, which can be used to import data into</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#234-236">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the length of the array</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#240-242">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>whether the array is empty</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.is_released" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#246-248">source</a><h4 class="code-header">pub fn <a href="#method.is_released" class="fn">is_released</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Whether the array has been released</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.offset" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#252-254">source</a><h4 class="code-header">pub fn <a href="#method.offset" class="fn">offset</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the offset of the array</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.null_count" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#258-260">source</a><h4 class="code-header">pub fn <a href="#method.null_count" class="fn">null_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>the null count of the array</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.buffer" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#267-273">source</a><h4 class="code-header">pub fn <a href="#method.buffer" class="fn">buffer</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </ [...]
<h5 id="panic"><a class="doc-anchor" href="#panic">§</a>Panic</h5>
<p>Panics if index exceeds the number of buffers or the buffer is not correctly aligned</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.num_buffers" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#324-326">source</a><h4 class="code-header">pub fn <a href="#method.num_buffers" class="fn">num_buffers</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of buffers</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.child" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#330-339">source</a><h4 class="code-header">pub fn <a href="#method.child" class="fn">child</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &<a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_data::ffi::FFI_ArrowArra [...]
-</div></details><details class="toggle method-toggle" open><summary><section id="method.num_children" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#343-345">source</a><h4 class="code-header">pub fn <a href="#method.num_children" class="fn">num_children</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of children</p>
-</div></details><details class="toggle method-toggle" open><summary><section id="method.dictionary" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#349-353">source</a><h4 class="code-header">pub fn <a href="#method.dictionary" class="fn">dictionary</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nigh [...]
+</div></details><details class="toggle method-toggle" open><summary><section id="method.num_buffers" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#277-279">source</a><h4 class="code-header">pub fn <a href="#method.num_buffers" class="fn">num_buffers</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of buffers</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.child" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#283-292">source</a><h4 class="code-header">pub fn <a href="#method.child" class="fn">child</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &<a class="struct" href="struct.FFI_ArrowArray.html" title="struct arrow_data::ffi::FFI_ArrowArra [...]
+</div></details><details class="toggle method-toggle" open><summary><section id="method.num_children" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#296-298">source</a><h4 class="code-header">pub fn <a href="#method.num_children" class="fn">num_children</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of children</p>
+</div></details><details class="toggle method-toggle" open><summary><section id="method.dictionary" class="method"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#302-306">source</a><h4 class="code-header">pub fn <a href="#method.dictionary" class="fn">dictionary</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nigh [...]
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-FFI_ArrowArray" class="impl"><a class="src rightside" href="../../src/arrow_data/ffi.rs.html#38">source</a><a href="#impl-Debug-for-FFI_ArrowArray" class="anchor">§</a><h3 class="code-header">impl < [...]
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href [...]
T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https:/ [...]
diff --git a/src/arrow_array/ffi.rs.html b/src/arrow_array/ffi.rs.html
index 4b45d13b7b6..c4240202f12 100644
--- a/src/arrow_array/ffi.rs.html
+++ b/src/arrow_array/ffi.rs.html
@@ -1979,32 +1979,32 @@ To export an array, create an `ArrowArray` using [ArrowArray::try_new].
(length + <span class="number">1</span>) * (bits / <span class="number">8</span>)
}
(DataType::Utf8, <span class="number">2</span>) | (DataType::Binary, <span class="number">2</span>) => {
- <span class="comment">// the len of the data buffer (buffer 2) equals the difference between the last value
- // and the first value of the offset buffer (buffer 1).
+ <span class="kw">if </span><span class="self">self</span>.array.is_empty() {
+ <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="number">0</span>);
+ }
+
+ <span class="comment">// the len of the data buffer (buffer 2) equals the last value of the offset buffer (buffer 1)
</span><span class="kw">let </span>len = <span class="self">self</span>.buffer_len(<span class="number">1</span>, dt)<span class="question-mark">?</span>;
<span class="comment">// first buffer is the null buffer => add(1)
// we assume that pointer is aligned for `i32`, as Utf8 uses `i32` offsets.
</span><span class="attr">#[allow(clippy::cast_ptr_alignment)]
</span><span class="kw">let </span>offset_buffer = <span class="self">self</span>.array.buffer(<span class="number">1</span>) <span class="kw">as </span><span class="kw-2">*const </span>i32;
- <span class="comment">// get first offset
- </span><span class="kw">let </span>start = (<span class="kw">unsafe </span>{ <span class="kw-2">*</span>offset_buffer.add(<span class="number">0</span>) }) <span class="kw">as </span>usize;
<span class="comment">// get last offset
- </span><span class="kw">let </span>end = (<span class="kw">unsafe </span>{ <span class="kw-2">*</span>offset_buffer.add(len / size_of::<i32>() - <span class="number">1</span>) }) <span class="kw">as </span>usize;
- end - start
+ </span>(<span class="kw">unsafe </span>{ <span class="kw-2">*</span>offset_buffer.add(len / size_of::<i32>() - <span class="number">1</span>) }) <span class="kw">as </span>usize
}
(DataType::LargeUtf8, <span class="number">2</span>) | (DataType::LargeBinary, <span class="number">2</span>) => {
- <span class="comment">// the len of the data buffer (buffer 2) equals the difference between the last value
- // and the first value of the offset buffer (buffer 1).
+ <span class="kw">if </span><span class="self">self</span>.array.is_empty() {
+ <span class="kw">return </span><span class="prelude-val">Ok</span>(<span class="number">0</span>);
+ }
+
+ <span class="comment">// the len of the data buffer (buffer 2) equals the last value of the offset buffer (buffer 1)
</span><span class="kw">let </span>len = <span class="self">self</span>.buffer_len(<span class="number">1</span>, dt)<span class="question-mark">?</span>;
<span class="comment">// first buffer is the null buffer => add(1)
// we assume that pointer is aligned for `i64`, as Large uses `i64` offsets.
</span><span class="attr">#[allow(clippy::cast_ptr_alignment)]
</span><span class="kw">let </span>offset_buffer = <span class="self">self</span>.array.buffer(<span class="number">1</span>) <span class="kw">as </span><span class="kw-2">*const </span>i64;
- <span class="comment">// get first offset
- </span><span class="kw">let </span>start = (<span class="kw">unsafe </span>{ <span class="kw-2">*</span>offset_buffer.add(<span class="number">0</span>) }) <span class="kw">as </span>usize;
<span class="comment">// get last offset
- </span><span class="kw">let </span>end = (<span class="kw">unsafe </span>{ <span class="kw-2">*</span>offset_buffer.add(len / size_of::<i64>() - <span class="number">1</span>) }) <span class="kw">as </span>usize;
- end - start
+ </span>(<span class="kw">unsafe </span>{ <span class="kw-2">*</span>offset_buffer.add(len / size_of::<i64>() - <span class="number">1</span>) }) <span class="kw">as </span>usize
}
<span class="comment">// buffer len of primitive types
</span><span class="kw">_ </span>=> {
diff --git a/src/arrow_data/ffi.rs.html b/src/arrow_data/ffi.rs.html
index ec7d8bbc4b2..cae15c02a4a 100644
--- a/src/arrow_data/ffi.rs.html
+++ b/src/arrow_data/ffi.rs.html
@@ -327,53 +327,6 @@
<a href="#327" id="327">327</a>
<a href="#328" id="328">328</a>
<a href="#329" id="329">329</a>
-<a href="#330" id="330">330</a>
-<a href="#331" id="331">331</a>
-<a href="#332" id="332">332</a>
-<a href="#333" id="333">333</a>
-<a href="#334" id="334">334</a>
-<a href="#335" id="335">335</a>
-<a href="#336" id="336">336</a>
-<a href="#337" id="337">337</a>
-<a href="#338" id="338">338</a>
-<a href="#339" id="339">339</a>
-<a href="#340" id="340">340</a>
-<a href="#341" id="341">341</a>
-<a href="#342" id="342">342</a>
-<a href="#343" id="343">343</a>
-<a href="#344" id="344">344</a>
-<a href="#345" id="345">345</a>
-<a href="#346" id="346">346</a>
-<a href="#347" id="347">347</a>
-<a href="#348" id="348">348</a>
-<a href="#349" id="349">349</a>
-<a href="#350" id="350">350</a>
-<a href="#351" id="351">351</a>
-<a href="#352" id="352">352</a>
-<a href="#353" id="353">353</a>
-<a href="#354" id="354">354</a>
-<a href="#355" id="355">355</a>
-<a href="#356" id="356">356</a>
-<a href="#357" id="357">357</a>
-<a href="#358" id="358">358</a>
-<a href="#359" id="359">359</a>
-<a href="#360" id="360">360</a>
-<a href="#361" id="361">361</a>
-<a href="#362" id="362">362</a>
-<a href="#363" id="363">363</a>
-<a href="#364" id="364">364</a>
-<a href="#365" id="365">365</a>
-<a href="#366" id="366">366</a>
-<a href="#367" id="367">367</a>
-<a href="#368" id="368">368</a>
-<a href="#369" id="369">369</a>
-<a href="#370" id="370">370</a>
-<a href="#371" id="371">371</a>
-<a href="#372" id="372">372</a>
-<a href="#373" id="373">373</a>
-<a href="#374" id="374">374</a>
-<a href="#375" id="375">375</a>
-<a href="#376" id="376">376</a>
</pre></div><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
@@ -507,37 +460,6 @@
data.buffers().iter().map(|b| <span class="prelude-val">Some</span>(b.clone())).collect()
};
- <span class="comment">// Handle buffer offset for offset buffer.
- </span><span class="kw">let </span>offset_offset = <span class="kw">match </span>data.data_type() {
- DataType::Utf8 | DataType::Binary => {
- <span class="comment">// Offset buffer is possible a slice of the buffer.
- // If we use slice pointer as exported buffer pointer, it will cause
- // the consumer to calculate incorrect length of data buffer (buffer 1).
- // We need to get the offset of the offset buffer and fill it in
- // the `FFI_ArrowArray` offset field.
- </span><span class="prelude-val">Some</span>(data.buffers()[<span class="number">0</span>].ptr_offset() / std::mem::size_of::<i32>())
- }
- DataType::LargeUtf8 | DataType::LargeBinary => {
- <span class="comment">// Offset buffer is possible a slice of the buffer.
- // If we use slice pointer as exported buffer pointer, it will cause
- // the consumer to calculate incorrect length of data buffer (buffer 1).
- // We need to get the offset of the offset buffer and fill it in
- // the `FFI_ArrowArray` offset field.
- </span><span class="prelude-val">Some</span>(data.buffers()[<span class="number">0</span>].ptr_offset() / std::mem::size_of::<i64>())
- }
- <span class="kw">_ </span>=> <span class="prelude-val">None</span>,
- };
-
- <span class="kw">let </span>offset = <span class="kw">if let </span><span class="prelude-val">Some</span>(offset) = offset_offset {
- <span class="kw">if </span>data.offset() != <span class="number">0 </span>{
- <span class="comment">// TODO: Adjust for data offset
- </span><span class="macro">panic!</span>(<span class="string">"The ArrayData of a slice offset buffer should not have offset"</span>);
- }
- offset
- } <span class="kw">else </span>{
- data.offset()
- };
-
<span class="comment">// `n_buffers` is the number of buffers by the spec.
</span><span class="kw">let </span>n_buffers = {
data_layout.buffers.len() + {
@@ -550,25 +472,9 @@
<span class="kw">let </span>buffers_ptr = buffers
.iter()
- .enumerate()
- .flat_map(|(buffer_idx, maybe_buffer)| <span class="kw">match </span>maybe_buffer {
- <span class="prelude-val">Some</span>(b) => {
- <span class="kw">match </span>(data.data_type(), buffer_idx) {
- (
- DataType::Utf8
- | DataType::LargeUtf8
- | DataType::Binary
- | DataType::LargeBinary,
- <span class="number">1</span>,
- ) => {
- <span class="comment">// For offset buffer, take original pointer without offset.
- // Buffer offset should be handled by `FFI_ArrowArray` offset field.
- </span><span class="prelude-val">Some</span>(b.data_ptr().as_ptr() <span class="kw">as </span><span class="kw-2">*const </span>c_void)
- }
- <span class="comment">// For other buffers, note that `raw_data` takes into account the buffer's offset
- </span><span class="kw">_ </span>=> <span class="prelude-val">Some</span>(b.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span>c_void),
- }
- }
+ .flat_map(|maybe_buffer| <span class="kw">match </span>maybe_buffer {
+ <span class="comment">// note that `raw_data` takes into account the buffer's offset
+ </span><span class="prelude-val">Some</span>(b) => <span class="prelude-val">Some</span>(b.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span>c_void),
<span class="comment">// This is for null buffer. We only put a null pointer for
// null buffer if by spec it can contain null mask.
</span><span class="prelude-val">None </span><span class="kw">if </span>data_layout.can_contain_null_mask => <span class="prelude-val">Some</span>(std::ptr::null()),
@@ -609,7 +515,7 @@
<span class="self">Self </span>{
length: data.len() <span class="kw">as </span>i64,
null_count: null_count <span class="kw">as </span>i64,
- offset: offset <span class="kw">as </span>i64,
+ offset: data.offset() <span class="kw">as </span>i64,
n_buffers,
n_children,
buffers: private_data.buffers_ptr.as_mut_ptr(),