mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-10-18 18:02:29 +00:00
18 lines
5.0 KiB
HTML
18 lines
5.0 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="Checks whether a string field builder that currently holds `current_len` bytes can additionally accommodate `space_needed` bytes of string data, given that the offset of a single Arrow string array is limited to `limit` (`i32::MAX` in production)."><title>check_string_capacity in mito2::memtable::time_series - 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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="mito2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.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 fn"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[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="#">check_string_capacity</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../mito2/index.html">mito2</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In mito2::<wbr>memtable::<wbr>time_<wbr>series</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">mito2</a>::<wbr><a href="../index.html">memtable</a>::<wbr><a href="index.html">time_series</a></div><h1>Function <span class="fn">check_<wbr>string_<wbr>capacity</span> <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/mito2/memtable/time_series.rs.html#94-106">Source</a> </span></div><pre class="rust item-decl"><code>fn check_string_capacity(
|
||
current_len: <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.i32.html">i32</a>,
|
||
space_needed: <a class="enum" href="https://doc.rust-lang.org/1.98.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.i32.html">i32</a>>,
|
||
limit: <a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.i32.html">i32</a>,
|
||
) -> <a class="type" href="../../error/type.Result.html" title="type mito2::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.98.1/std/primitive.bool.html">bool</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Checks whether a string field builder that currently holds <code>current_len</code> bytes can
|
||
additionally accommodate <code>space_needed</code> bytes of string data, given that the offset of a
|
||
single Arrow string array is limited to <code>limit</code> (<code>i32::MAX</code> in production).</p>
|
||
<p>Returns:</p>
|
||
<ul>
|
||
<li><code>Ok(true)</code> if <code>current_len + space_needed <= limit</code>;</li>
|
||
<li><code>Ok(false)</code> if <code>space_needed <= limit</code> but <code>current_len + space_needed > limit</code>, i.e.
|
||
the current builder is too full but an empty builder could accommodate the batch (the
|
||
caller may freeze the current builder and replay the batch onto an empty one);</li>
|
||
<li><code>Err(InvalidBatchSnafu)</code> if the batch’s string data alone (<code>space_needed</code>, or the fact
|
||
that its total bytes cannot even be represented as <code>i32</code>) exceeds <code>limit</code>, i.e. the
|
||
batch can never be accommodated by any builder.</li>
|
||
</ul>
|
||
</div></details></section></div></main></body></html> |