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-dotnet.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 82d8cb3 Update docs for 06793ba4e48cbf3b61e0c41c30b710c08ebcf368
82d8cb3 is described below
commit 82d8cb32915c63206647112a3f60a9f3858db0e6
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Oct 7 02:33:43 2025 +0000
Update docs for 06793ba4e48cbf3b61e0c41c30b710c08ebcf368
---
main/api/Apache.Arrow.ArrowBuffer.html | 22 ++++++------
main/api/Apache.Arrow.C.CArrowArrayExporter.html | 39 ++++++++++++++++++++--
.../Apache.Arrow.Memory.NativeMemoryManager.html | 12 +++----
main/index.json | 2 +-
main/xrefmap.yml | 6 ++++
5 files changed, 61 insertions(+), 20 deletions(-)
diff --git a/main/api/Apache.Arrow.ArrowBuffer.html
b/main/api/Apache.Arrow.ArrowBuffer.html
index 8d6364d..00b33d3 100644
--- a/main/api/Apache.Arrow.ArrowBuffer.html
+++ b/main/api/Apache.Arrow.ArrowBuffer.html
@@ -89,7 +89,7 @@
<h1 id="Apache_Arrow_ArrowBuffer" data-uid="Apache.Arrow.ArrowBuffer"
class="text-break">
-Struct ArrowBuffer <a class="header-action link-secondary" title="View
source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L23";><i
class="bi bi-code-slash"></i></a>
+Struct ArrowBuffer <a class="header-action link-secondary" title="View
source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L24";><i
class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
@@ -153,7 +153,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_ArrowBuffer__ctor_System_ReadOnlyMemory_System_Byte__"
data-uid="Apache.Arrow.ArrowBuffer.#ctor(System.ReadOnlyMemory{System.Byte})">
ArrowBuffer(ReadOnlyMemory<byte>)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L30";><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/#L31";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -188,7 +188,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_ArrowBuffer_Empty"
data-uid="Apache.Arrow.ArrowBuffer.Empty">
Empty
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L28";><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/#L29";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -219,7 +219,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_ArrowBuffer_IsEmpty"
data-uid="Apache.Arrow.ArrowBuffer.IsEmpty">
IsEmpty
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L49";><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/#L50";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -250,7 +250,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_ArrowBuffer_Length"
data-uid="Apache.Arrow.ArrowBuffer.Length">
Length
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L51";><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/#L52";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -281,7 +281,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
<h3 id="Apache_Arrow_ArrowBuffer_Memory"
data-uid="Apache.Arrow.ArrowBuffer.Memory">
Memory
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.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/ArrowBuffer.cs/#L47";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -312,7 +312,7 @@ 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/#L53";><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/#L54";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -347,7 +347,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/#L59";><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/#L60";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -383,7 +383,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/#L71";><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"></div>
@@ -409,7 +409,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/#L66";><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/#L67";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -445,7 +445,7 @@ Struct ArrowBuffer <a class="header-action link-secondary"
title="View source"
</article>
<div class="contribution d-print-none">
- <a
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L23";
class="edit-link">Edit this page</a>
+ <a
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/ArrowBuffer.cs/#L24";
class="edit-link">Edit this page</a>
</div>
diff --git a/main/api/Apache.Arrow.C.CArrowArrayExporter.html
b/main/api/Apache.Arrow.C.CArrowArrayExporter.html
index 271d2a7..28402b8 100644
--- a/main/api/Apache.Arrow.C.CArrowArrayExporter.html
+++ b/main/api/Apache.Arrow.C.CArrowArrayExporter.html
@@ -148,6 +148,41 @@ Class CArrowArrayExporter <a class="header-action
link-secondary" title="View s
+ <h2 class="section" id="fields">Fields
+</h2>
+
+
+
+ <h3 id="Apache_Arrow_C_CArrowArrayExporter_EnableManagedMemoryExport"
data-uid="Apache.Arrow.C.CArrowArrayExporter.EnableManagedMemoryExport">
+ EnableManagedMemoryExport
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/C/CArrowArrayExporter.cs/#L32";><i
class="bi bi-code-slash"></i></a>
+ </h3>
+
+ <div class="markdown level1 summary"><p>Experimental feature to enable
exporting managed memory to CArrowArray. Use with caution.</p>
+</div>
+ <div class="markdown level1 conceptual"></div>
+
+ <div class="codewrapper">
+ <pre><code class="lang-csharp hljs">public static bool
EnableManagedMemoryExport</code></pre>
+ </div>
+
+
+
+
+ <h4 class="section">Field Value</h4>
+ <dl class="parameters">
+ <dt><a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.boolean";>bool</a></dt>
+ <dd></dd>
+ </dl>
+
+
+
+
+
+
+
+
+
<h2 class="section" id="methods">Methods
</h2>
@@ -156,7 +191,7 @@ Class CArrowArrayExporter <a class="header-action
link-secondary" title="View s
<h3
id="Apache_Arrow_C_CArrowArrayExporter_ExportArray_Apache_Arrow_IArrowArray_Apache_Arrow_C_CArrowArray__"
data-uid="Apache.Arrow.C.CArrowArrayExporter.ExportArray(Apache.Arrow.IArrowArray,Apache.Arrow.C.CArrowArray*)">
ExportArray(IArrowArray, CArrowArray*)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/C/CArrowArrayExporter.cs/#L50";><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/C/CArrowArrayExporter.cs/#L55";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Export an <a class="xref"
href="Apache.Arrow.IArrowArray.html">IArrowArray</a> to a <a class="xref"
href="Apache.Arrow.C.CArrowArray.html">CArrowArray</a>. Whether or not the
@@ -199,7 +234,7 @@ foreign_import_function(exportPtr);</code></pre>
<h3
id="Apache_Arrow_C_CArrowArrayExporter_ExportRecordBatch_Apache_Arrow_RecordBatch_Apache_Arrow_C_CArrowArray__"
data-uid="Apache.Arrow.C.CArrowArrayExporter.ExportRecordBatch(Apache.Arrow.RecordBatch,Apache.Arrow.C.CArrowArray*)">
ExportRecordBatch(RecordBatch, CArrowArray*)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/C/CArrowArrayExporter.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/C/CArrowArrayExporter.cs/#L92";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Export a <a class="xref"
href="Apache.Arrow.RecordBatch.html">RecordBatch</a> to a <a class="xref"
href="Apache.Arrow.C.CArrowArray.html">CArrowArray</a>. Whether or not the
diff --git a/main/api/Apache.Arrow.Memory.NativeMemoryManager.html
b/main/api/Apache.Arrow.Memory.NativeMemoryManager.html
index cbb1fd3..9cb2d2a 100644
--- a/main/api/Apache.Arrow.Memory.NativeMemoryManager.html
+++ b/main/api/Apache.Arrow.Memory.NativeMemoryManager.html
@@ -177,7 +177,7 @@ Class NativeMemoryManager <a class="header-action
link-secondary" title="View s
<h3
id="Apache_Arrow_Memory_NativeMemoryManager__ctor_System_IntPtr_System_Int32_System_Int32_"
data-uid="Apache.Arrow.Memory.NativeMemoryManager.#ctor(System.IntPtr,System.Int32,System.Int32)">
NativeMemoryManager(IntPtr, int, int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Memory/NativeMemoryManager.cs/#L30";><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/Memory/NativeMemoryManager.cs/#L31";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -216,7 +216,7 @@ Class NativeMemoryManager <a class="header-action
link-secondary" title="View s
<h3 id="Apache_Arrow_Memory_NativeMemoryManager_Dispose_System_Boolean_"
data-uid="Apache.Arrow.Memory.NativeMemoryManager.Dispose(System.Boolean)">
Dispose(bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Memory/NativeMemoryManager.cs/#L71";><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/Memory/NativeMemoryManager.cs/#L73";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Clean up of any leftover managed and
unmanaged resources.</p>
@@ -248,7 +248,7 @@ Class NativeMemoryManager <a class="header-action
link-secondary" title="View s
<h3 id="Apache_Arrow_Memory_NativeMemoryManager_Finalize"
data-uid="Apache.Arrow.Memory.NativeMemoryManager.Finalize">
~NativeMemoryManager()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Memory/NativeMemoryManager.cs/#L44";><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/Memory/NativeMemoryManager.cs/#L45";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -274,7 +274,7 @@ Class NativeMemoryManager <a class="header-action
link-secondary" title="View s
<h3 id="Apache_Arrow_Memory_NativeMemoryManager_GetSpan"
data-uid="Apache.Arrow.Memory.NativeMemoryManager.GetSpan">
GetSpan()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Memory/NativeMemoryManager.cs/#L50";><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/Memory/NativeMemoryManager.cs/#L51";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Returns a span wrapping the
underlying memory.</p>
@@ -306,7 +306,7 @@ Class NativeMemoryManager <a class="header-action
link-secondary" title="View s
<h3 id="Apache_Arrow_Memory_NativeMemoryManager_Pin_System_Int32_"
data-uid="Apache.Arrow.Memory.NativeMemoryManager.Pin(System.Int32)">
Pin(int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Memory/NativeMemoryManager.cs/#L56";><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/Memory/NativeMemoryManager.cs/#L57";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Returns a handle to the memory that
has been pinned and hence its address can be taken.</p>
@@ -344,7 +344,7 @@ Class NativeMemoryManager <a class="header-action
link-secondary" title="View s
<h3 id="Apache_Arrow_Memory_NativeMemoryManager_Unpin"
data-uid="Apache.Arrow.Memory.NativeMemoryManager.Unpin">
Unpin()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Memory/NativeMemoryManager.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/Memory/NativeMemoryManager.cs/#L67";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Lets the garbage collector know that
the object is free to be moved now.</p>
diff --git a/main/index.json b/main/index.json
index 34de694..688e4d6 100644
--- a/main/index.json
+++ b/main/index.json
@@ -122,7 +122,7 @@
"api/Apache.Arrow.C.CArrowArrayExporter.html": {
"href": "api/Apache.Arrow.C.CArrowArrayExporter.html",
"title": "Class CArrowArrayExporter | Apache Arrow .NET",
- "summary": "Class CArrowArrayExporter Namespace Apache.Arrow.C Assembly
Apache.Arrow.dll public static class CArrowArrayExporter Inheritance object
CArrowArrayExporter Inherited Members object.Equals(object)
object.Equals(object, object) object.GetHashCode() object.GetType()
object.MemberwiseClone() object.ReferenceEquals(object, object)
object.ToString() Methods ExportArray(IArrowArray, CArrowArray*) Export an
IArrowArray to a CArrowArray. Whether or not the export succeeds, the ori [...]
+ "summary": "Class CArrowArrayExporter Namespace Apache.Arrow.C Assembly
Apache.Arrow.dll public static class CArrowArrayExporter Inheritance object
CArrowArrayExporter Inherited Members object.Equals(object)
object.Equals(object, object) object.GetHashCode() object.GetType()
object.MemberwiseClone() object.ReferenceEquals(object, object)
object.ToString() Fields EnableManagedMemoryExport Experimental feature to
enable exporting managed memory to CArrowArray. Use with caution. public [...]
},
"api/Apache.Arrow.C.CArrowArrayImporter.html": {
"href": "api/Apache.Arrow.C.CArrowArrayImporter.html",
diff --git a/main/xrefmap.yml b/main/xrefmap.yml
index 4e7b8d3..245214b 100644
--- a/main/xrefmap.yml
+++ b/main/xrefmap.yml
@@ -3331,6 +3331,12 @@ references:
commentId: T:Apache.Arrow.C.CArrowArrayExporter
fullName: Apache.Arrow.C.CArrowArrayExporter
nameWithType: CArrowArrayExporter
+- uid: Apache.Arrow.C.CArrowArrayExporter.EnableManagedMemoryExport
+ name: EnableManagedMemoryExport
+ href:
api/Apache.Arrow.C.CArrowArrayExporter.html#Apache_Arrow_C_CArrowArrayExporter_EnableManagedMemoryExport
+ commentId: F:Apache.Arrow.C.CArrowArrayExporter.EnableManagedMemoryExport
+ fullName: Apache.Arrow.C.CArrowArrayExporter.EnableManagedMemoryExport
+ nameWithType: CArrowArrayExporter.EnableManagedMemoryExport
- uid:
Apache.Arrow.C.CArrowArrayExporter.ExportArray(Apache.Arrow.IArrowArray,Apache.Arrow.C.CArrowArray*)
name: ExportArray(IArrowArray, CArrowArray*)
href:
api/Apache.Arrow.C.CArrowArrayExporter.html#Apache_Arrow_C_CArrowArrayExporter_ExportArray_Apache_Arrow_IArrowArray_Apache_Arrow_C_CArrowArray__
