This is an automated email from the ASF dual-hosted git repository.
github-actions[bot] pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-dotnet.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 6b487d9 Update docs for 08b2b16269a146cdc1495d04c2aaf0900f37b949
6b487d9 is described below
commit 6b487d955cad2f59c5174220eaecb369161f211e
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Aug 18 22:37:13 2026 +0000
Update docs for 08b2b16269a146cdc1495d04c2aaf0900f37b949
---
main/api/Apache.Arrow.ArrowBuffer.html | 17 +++++++++++------
main/api/Apache.Arrow.BinaryArray.html | 6 +++++-
main/api/Apache.Arrow.BooleanArray.html | 19 ++++++++++++-------
main/api/Apache.Arrow.PrimitiveArray-1.html | 13 +++++++++----
main/index.json | 8 ++++----
5 files changed, 41 insertions(+), 22 deletions(-)
diff --git a/main/api/Apache.Arrow.ArrowBuffer.html
b/main/api/Apache.Arrow.ArrowBuffer.html
index 80bb14e..0313b7f 100644
--- a/main/api/Apache.Arrow.ArrowBuffer.html
+++ b/main/api/Apache.Arrow.ArrowBuffer.html
@@ -312,10 +312,11 @@ Struct ArrowBuffer <a class="header-action
link-secondary" title="View source"
<h3 id="Apache_Arrow_ArrowBuffer_Span"
data-uid="Apache.Arrow.ArrowBuffer.Span">
Span
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L55";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L62";><i
class="bi bi-code-slash"></i></a>
</h3>
- <div class="markdown level1 summary"></div>
+ <div class="markdown level1 summary"><p>Gets a read-only span over the
buffer contents.</p>
+</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -335,6 +336,10 @@ Struct ArrowBuffer <a class="header-action
link-secondary" title="View source"
+ <h4 class="section" id="Apache_Arrow_ArrowBuffer_Span_remarks">Remarks</h4>
+ <div class="markdown level1 remarks"><p>CAUTION: The returned ReadOnlySpan
points directly to memory managed by this ArrowBuffer.
+Ensure the ArrowBuffer instance remains rooted and undisposed while using this
span to prevent use-after-free.</p>
+</div>
@@ -347,7 +352,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_ArrowBuffer_Clone_Apache_Arrow_Memory_MemoryAllocator_"
data-uid="Apache.Arrow.ArrowBuffer.Clone(Apache.Arrow.Memory.MemoryAllocator)">
Clone(MemoryAllocator)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L75";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L82";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -383,7 +388,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_ArrowBuffer_Dispose"
data-uid="Apache.Arrow.ArrowBuffer.Dispose">
Dispose()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L87";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L94";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -409,7 +414,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_ArrowBuffer_Equals_Apache_Arrow_ArrowBuffer_"
data-uid="Apache.Arrow.ArrowBuffer.Equals(Apache.Arrow.ArrowBuffer)">
Equals(ArrowBuffer)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L82";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L89";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -445,7 +450,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_ArrowBuffer_Retain"
data-uid="Apache.Arrow.ArrowBuffer.Retain">
Retain()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L65";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L72";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Adds another reference to the memory
used by this buffer. Allows a single buffer
diff --git a/main/api/Apache.Arrow.BinaryArray.html
b/main/api/Apache.Arrow.BinaryArray.html
index 11bb38c..da3ffc1 100644
--- a/main/api/Apache.Arrow.BinaryArray.html
+++ b/main/api/Apache.Arrow.BinaryArray.html
@@ -536,7 +536,7 @@ to reliably determine null values.</p>
<h3 id="Apache_Arrow_BinaryArray_GetBytes_System_Int32_System_Boolean__"
data-uid="Apache.Arrow.BinaryArray.GetBytes(System.Int32,System.Boolean@)">
GetBytes(int, out bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BinaryArray.cs/#L391";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BinaryArray.cs/#L395";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Get the collection of bytes, as a
read-only span, at a given index in the array.</p>
@@ -570,6 +570,10 @@ to reliably determine null values.</p>
+ <h4 class="section"
id="Apache_Arrow_BinaryArray_GetBytes_System_Int32_System_Boolean___remarks">Remarks</h4>
+ <div class="markdown level1 remarks"><p>CAUTION: The returned ReadOnlySpan
is not GC-tracked if backed by unmanaged memory.
+Ensure the BinaryArray object remains in scope and undisposed while accessing
this span.</p>
+</div>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
diff --git a/main/api/Apache.Arrow.BooleanArray.html
b/main/api/Apache.Arrow.BooleanArray.html
index b26a650..9cb7f5a 100644
--- a/main/api/Apache.Arrow.BooleanArray.html
+++ b/main/api/Apache.Arrow.BooleanArray.html
@@ -209,7 +209,7 @@ Class BooleanArray <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_BooleanArray__ctor_Apache_Arrow_ArrayData_"
data-uid="Apache.Arrow.BooleanArray.#ctor(Apache.Arrow.ArrayData)">
BooleanArray(ArrayData)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L174";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L182";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -240,7 +240,7 @@ Class BooleanArray <a class="header-action link-secondary"
title="View source"
<h3
id="Apache_Arrow_BooleanArray__ctor_Apache_Arrow_ArrowBuffer_Apache_Arrow_ArrowBuffer_System_Int32_System_Int32_System_Int32_"
data-uid="Apache.Arrow.BooleanArray.#ctor(Apache.Arrow.ArrowBuffer,Apache.Arrow.ArrowBuffer,System.Int32,System.Int32,System.Int32)">
BooleanArray(ArrowBuffer, ArrowBuffer, int, int, int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L167";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L175";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -314,10 +314,11 @@ Class BooleanArray <a class="header-action
link-secondary" title="View source"
<h3 id="Apache_Arrow_BooleanArray_Values"
data-uid="Apache.Arrow.BooleanArray.Values">
Values
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L165";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L173";><i
class="bi bi-code-slash"></i></a>
</h3>
- <div class="markdown level1 summary"></div>
+ <div class="markdown level1 summary"><p>Gets the boolean array values as a
span of bytes (a bitmap).</p>
+</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -337,6 +338,10 @@ Class BooleanArray <a class="header-action
link-secondary" title="View source"
+ <h4 class="section"
id="Apache_Arrow_BooleanArray_Values_remarks">Remarks</h4>
+ <div class="markdown level1 remarks"><p>CAUTION: The returned ReadOnlySpan
is not GC-tracked if backed by unmanaged memory.
+Ensure the BooleanArray object remains in scope and undisposed while accessing
this span.</p>
+</div>
@@ -349,7 +354,7 @@ Class BooleanArray <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_BooleanArray_Accept_Apache_Arrow_IArrowArrayVisitor_"
data-uid="Apache.Arrow.BooleanArray.Accept(Apache.Arrow.IArrowArrayVisitor)">
Accept(IArrowArrayVisitor)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L180";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L188";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -380,7 +385,7 @@ Class BooleanArray <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_BooleanArray_GetBoolean_System_Int32_"
data-uid="Apache.Arrow.BooleanArray.GetBoolean(System.Int32)">
GetBoolean(int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L182";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L190";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -417,7 +422,7 @@ public bool GetBoolean(int index)</code></pre>
<h3 id="Apache_Arrow_BooleanArray_GetValue_System_Int32_"
data-uid="Apache.Arrow.BooleanArray.GetValue(System.Int32)">
GetValue(int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L188";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/BooleanArray.cs/#L196";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
diff --git a/main/api/Apache.Arrow.PrimitiveArray-1.html
b/main/api/Apache.Arrow.PrimitiveArray-1.html
index 2a7de84..b4319d9 100644
--- a/main/api/Apache.Arrow.PrimitiveArray-1.html
+++ b/main/api/Apache.Arrow.PrimitiveArray-1.html
@@ -305,10 +305,11 @@ Class PrimitiveArray<T> <a class="header-action
link-secondary" title="Vi
<h3 id="Apache_Arrow_PrimitiveArray_1_Values"
data-uid="Apache.Arrow.PrimitiveArray`1.Values">
Values
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/PrimitiveArray.cs/#L34";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/PrimitiveArray.cs/#L41";><i
class="bi bi-code-slash"></i></a>
</h3>
- <div class="markdown level1 summary"></div>
+ <div class="markdown level1 summary"><p>Gets the array values as a span.</p>
+</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -328,6 +329,10 @@ Class PrimitiveArray<T> <a class="header-action
link-secondary" title="Vi
+ <h4 class="section"
id="Apache_Arrow_PrimitiveArray_1_Values_remarks">Remarks</h4>
+ <div class="markdown level1 remarks"><p>CAUTION: The returned ReadOnlySpan
is not GC-tracked if backed by unmanaged memory.
+Ensure the PrimitiveArray object remains in scope and undisposed while
accessing this span.</p>
+</div>
@@ -340,7 +345,7 @@ Class PrimitiveArray<T> <a class="header-action
link-secondary" title="Vi
<h3 id="Apache_Arrow_PrimitiveArray_1_GetValue_System_Int32_"
data-uid="Apache.Arrow.PrimitiveArray`1.GetValue(System.Int32)">
GetValue(int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/PrimitiveArray.cs/#L36";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/PrimitiveArray.cs/#L43";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -376,7 +381,7 @@ Class PrimitiveArray<T> <a class="header-action
link-secondary" title="Vi
<h3 id="Apache_Arrow_PrimitiveArray_1_ToList_System_Boolean_"
data-uid="Apache.Arrow.PrimitiveArray`1.ToList(System.Boolean)">
ToList(bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/PrimitiveArray.cs/#L46";><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/PrimitiveArray.cs/#L53";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
diff --git a/main/index.json b/main/index.json
index 49f1ea5..69ab890 100644
--- a/main/index.json
+++ b/main/index.json
@@ -57,7 +57,7 @@
"api/Apache.Arrow.ArrowBuffer.html": {
"href": "api/Apache.Arrow.ArrowBuffer.html",
"title": "Struct ArrowBuffer | Apache Arrow .NET",
- "summary": "Struct ArrowBuffer Namespace Apache.Arrow Assembly
Apache.Arrow.dll public readonly struct ArrowBuffer : IEquatable<ArrowBuffer>,
IDisposable Implements IEquatable<ArrowBuffer> IDisposable Inherited Members
ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString()
object.Equals(object, object) object.GetType() object.ReferenceEquals(object,
object) Constructors ArrowBuffer(ReadOnlyMemory<byte>) public
ArrowBuffer(ReadOnlyMemory<byte> data) Parameters data Read [...]
+ "summary": "Struct ArrowBuffer Namespace Apache.Arrow Assembly
Apache.Arrow.dll public readonly struct ArrowBuffer : IEquatable<ArrowBuffer>,
IDisposable Implements IEquatable<ArrowBuffer> IDisposable Inherited Members
ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString()
object.Equals(object, object) object.GetType() object.ReferenceEquals(object,
object) Constructors ArrowBuffer(ReadOnlyMemory<byte>) public
ArrowBuffer(ReadOnlyMemory<byte> data) Parameters data Read [...]
},
"api/Apache.Arrow.ArrowContext.html": {
"href": "api/Apache.Arrow.ArrowContext.html",
@@ -87,7 +87,7 @@
"api/Apache.Arrow.BinaryArray.html": {
"href": "api/Apache.Arrow.BinaryArray.html",
"title": "Class BinaryArray | Apache Arrow .NET",
- "summary": "Class BinaryArray Namespace Apache.Arrow Assembly
Apache.Arrow.dll public class BinaryArray : Array, IArrowArray, IDisposable,
IReadOnlyList<byte[]>, IReadOnlyCollection<byte[]>, ICollection<byte[]>,
IEnumerable<byte[]>, IEnumerable Inheritance object Array BinaryArray
Implements IArrowArray IDisposable IReadOnlyList<byte[]>
IReadOnlyCollection<byte[]> ICollection<byte[]> IEnumerable<byte[]> IEnumerable
Derived StringArray Inherited Members Array.Data Array.Length Array.O [...]
+ "summary": "Class BinaryArray Namespace Apache.Arrow Assembly
Apache.Arrow.dll public class BinaryArray : Array, IArrowArray, IDisposable,
IReadOnlyList<byte[]>, IReadOnlyCollection<byte[]>, ICollection<byte[]>,
IEnumerable<byte[]>, IEnumerable Inheritance object Array BinaryArray
Implements IArrowArray IDisposable IReadOnlyList<byte[]>
IReadOnlyCollection<byte[]> ICollection<byte[]> IEnumerable<byte[]> IEnumerable
Derived StringArray Inherited Members Array.Data Array.Length Array.O [...]
},
"api/Apache.Arrow.BinaryViewArray.Builder.html": {
"href": "api/Apache.Arrow.BinaryViewArray.Builder.html",
@@ -137,7 +137,7 @@
"api/Apache.Arrow.BooleanArray.html": {
"href": "api/Apache.Arrow.BooleanArray.html",
"title": "Class BooleanArray | Apache Arrow .NET",
- "summary": "Class BooleanArray Namespace Apache.Arrow Assembly
Apache.Arrow.dll public class BooleanArray : Array, IArrowArray, IDisposable,
IReadOnlyList<bool?>, IReadOnlyCollection<bool?>, ICollection<bool?>,
IEnumerable<bool?>, IEnumerable Inheritance object Array BooleanArray
Implements IArrowArray IDisposable IReadOnlyList<bool?>
IReadOnlyCollection<bool?> ICollection<bool?> IEnumerable<bool?> IEnumerable
Inherited Members Array.Data Array.Length Array.Offset Array.NullCount Arr [...]
+ "summary": "Class BooleanArray Namespace Apache.Arrow Assembly
Apache.Arrow.dll public class BooleanArray : Array, IArrowArray, IDisposable,
IReadOnlyList<bool?>, IReadOnlyCollection<bool?>, ICollection<bool?>,
IEnumerable<bool?>, IEnumerable Inheritance object Array BooleanArray
Implements IArrowArray IDisposable IReadOnlyList<bool?>
IReadOnlyCollection<bool?> ICollection<bool?> IEnumerable<bool?> IEnumerable
Inherited Members Array.Data Array.Length Array.Offset Array.NullCount Arr [...]
},
"api/Apache.Arrow.C.ArrowDeviceType.html": {
"href": "api/Apache.Arrow.C.ArrowDeviceType.html",
@@ -1107,7 +1107,7 @@
"api/Apache.Arrow.PrimitiveArray-1.html": {
"href": "api/Apache.Arrow.PrimitiveArray-1.html",
"title": "Class PrimitiveArray<T> | Apache Arrow .NET",
- "summary": "Class PrimitiveArray<T> Namespace Apache.Arrow Assembly
Apache.Arrow.dll public abstract class PrimitiveArray<T> : Array, IArrowArray,
IDisposable, IReadOnlyList<T?>, IReadOnlyCollection<T?>, ICollection<T?>,
IEnumerable<T?>, IEnumerable where T : struct, IEquatable<T> Type Parameters T
Inheritance object Array PrimitiveArray<T> Implements IArrowArray IDisposable
IReadOnlyList<T?> IReadOnlyCollection<T?> ICollection<T?> IEnumerable<T?>
IEnumerable Derived Date32Array Date [...]
+ "summary": "Class PrimitiveArray<T> Namespace Apache.Arrow Assembly
Apache.Arrow.dll public abstract class PrimitiveArray<T> : Array, IArrowArray,
IDisposable, IReadOnlyList<T?>, IReadOnlyCollection<T?>, ICollection<T?>,
IEnumerable<T?>, IEnumerable where T : struct, IEquatable<T> Type Parameters T
Inheritance object Array PrimitiveArray<T> Implements IArrowArray IDisposable
IReadOnlyList<T?> IReadOnlyCollection<T?> ICollection<T?> IEnumerable<T?>
IEnumerable Derived Date32Array Date [...]
},
"api/Apache.Arrow.PrimitiveArrayBuilder-3.html": {
"href": "api/Apache.Arrow.PrimitiveArrayBuilder-3.html",
