Files
greptimedb/common_recordbatch/index.html
2025-12-22 06:16:12 +00:00

3 lines
8.5 KiB
HTML

<!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="API documentation for the Rust `common_recordbatch` crate."><title>common_recordbatch - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="common_recordbatch" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Crate common_recordbatch</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_recordbatch/index.html">common_<wbr>recordbatch</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>common_<wbr>recordbatch</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/common_recordbatch/lib.rs.html#15-1047">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.RecordBatch"><code>pub use recordbatch::<a class="struct" href="recordbatch/struct.RecordBatch.html" title="struct common_recordbatch::recordbatch::RecordBatch">RecordBatch</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="adapter/index.html" title="mod common_recordbatch::adapter">adapter</a></dt><dt><a class="mod" href="cursor/index.html" title="mod common_recordbatch::cursor">cursor</a></dt><dt><a class="mod" href="error/index.html" title="mod common_recordbatch::error">error</a></dt><dd>Error of record batch.</dd><dt><a class="mod" href="filter/index.html" title="mod common_recordbatch::filter">filter</a></dt><dd>Util record batch stream wrapper that can perform precise filter.</dd><dt><a class="mod" href="recordbatch/index.html" title="mod common_recordbatch::recordbatch">recordbatch</a></dt><dt><a class="mod" href="util/index.html" title="mod common_recordbatch::util">util</a></dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.DfRecordBatch.html" title="struct common_recordbatch::DfRecordBatch">DfRecord<wbr>Batch</a></dt><dd>A two-dimensional batch of column-oriented data with a defined
<a href="arrow_schema::Schema">schema</a>.</dd><dt><a class="struct" href="struct.EmptyRecordBatchStream.html" title="struct common_recordbatch::EmptyRecordBatchStream">Empty<wbr>Record<wbr>Batch<wbr>Stream</a></dt><dd>EmptyRecordBatchStream can be used to create a RecordBatchStream
that will produce no results</dd><dt><a class="struct" href="struct.MemoryPermit.html" title="struct common_recordbatch::MemoryPermit">Memory<wbr>Permit</a></dt><dd>Memory permit for a stream, providing privileged access or rate limiting.</dd><dt><a class="struct" href="struct.MemoryTrackedStream.html" title="struct common_recordbatch::MemoryTrackedStream">Memory<wbr>Tracked<wbr>Stream</a></dt><dd>A wrapper stream that tracks memory usage of RecordBatches.</dd><dt><a class="struct" href="struct.OrderOption.html" title="struct common_recordbatch::OrderOption">Order<wbr>Option</a></dt><dt><a class="struct" href="struct.QueryMemoryTracker.html" title="struct common_recordbatch::QueryMemoryTracker">Query<wbr>Memory<wbr>Tracker</a></dt><dd>Memory tracker for RecordBatch streams. Clone to share the same limit across queries.</dd><dt><a class="struct" href="struct.RecordBatchStreamWrapper.html" title="struct common_recordbatch::RecordBatchStreamWrapper">Record<wbr>Batch<wbr>Stream<wbr>Wrapper</a></dt><dd>Adapt a [Stream] of <a href="recordbatch/struct.RecordBatch.html" title="struct common_recordbatch::recordbatch::RecordBatch">RecordBatch</a> to a <a href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a>.</dd><dt><a class="struct" href="struct.RecordBatches.html" title="struct common_recordbatch::RecordBatches">Record<wbr>Batches</a></dt><dt><a class="struct" href="struct.SendableRecordBatchMapper.html" title="struct common_recordbatch::SendableRecordBatchMapper">Sendable<wbr>Record<wbr>Batch<wbr>Mapper</a></dt><dd>A wrapper that maps a <a href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> to a new <a href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> by applying a function to each <a href="recordbatch/struct.RecordBatch.html" title="struct common_recordbatch::recordbatch::RecordBatch">RecordBatch</a>.</dd><dt><a class="struct" href="struct.SimpleRecordBatchStream.html" title="struct common_recordbatch::SimpleRecordBatchStream">Simple<wbr>Record<wbr>Batch<wbr>Stream</a></dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">Record<wbr>Batch<wbr>Stream</a></dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.map_json_type_to_string.html" title="fn common_recordbatch::map_json_type_to_string">map_<wbr>json_<wbr>type_<wbr>to_<wbr>string</a></dt><dd>Maps the json type to string in the batch.</dd><dt><a class="fn" href="fn.map_json_type_to_string_schema.html" title="fn common_recordbatch::map_json_type_to_string_schema">map_<wbr>json_<wbr>type_<wbr>to_<wbr>string_<wbr>schema</a></dt><dd>Maps the json type to string in the schema.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.DfSendableRecordBatchStream.html" title="type common_recordbatch::DfSendableRecordBatchStream">DfSendable<wbr>Record<wbr>Batch<wbr>Stream</a></dt><dd>Trait for a [<code>Stream</code>] of <a href="struct.DfRecordBatch.html" title="struct common_recordbatch::DfRecordBatch"><code>RecordBatch</code></a>es that can be passed between threads</dd><dt><a class="type" href="type.SendableRecordBatchStream.html" title="type common_recordbatch::SendableRecordBatchStream">Sendable<wbr>Record<wbr>Batch<wbr>Stream</a></dt></dl></section></div></main></body></html>