rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-07-04 13:00:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ GreptimeTeam/greptimedb@5a7a9c9f07 🚀

Browse Source
This commit is contained in:
github-merge-queue[bot]
2026-06-30 13:32:50 +00:00
commit da077e29be
22823 changed files with 2651054 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

244
cli/data/progress/enum.ProgressMode.html Normal file
View File

File diff suppressed because one or more lines are too long

237
cli/data/progress/enum.ProgressOutputKind.html Normal file
View File

File diff suppressed because one or more lines are too long

6
cli/data/progress/fn.build_progress_reporter.html Normal file
View File

@@ -0,0 +1,6 @@
<!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="Builds the progress reporter for `mode`. `never` is silent; otherwise an interactive bar is used on TTY stderr, falling back to lightweight log progress when stderr is redirected."><title>build_progress_reporter in cli::data::progress - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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="#">build_progress_reporter</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>data::<wbr>progress</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">cli</a>::<wbr><a href="../index.html">data</a>::<wbr><a href="index.html">progress</a></div><h1>Function <span class="fn">build_<wbr>progress_<wbr>reporter</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/cli/data/progress.rs.html#93-103">Source</a> </span></div><pre class="rust item-decl"><code>pub(crate) fn build_progress_reporter(
mode: <a class="enum" href="enum.ProgressMode.html" title="enum cli::data::progress::ProgressMode">ProgressMode</a>,
) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="trait.ProgressReporter.html" title="trait cli::data::progress::ProgressReporter">ProgressReporter</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Builds the progress reporter for <code>mode</code>. <code>never</code> is silent; otherwise an
interactive bar is used on TTY stderr, falling back to lightweight log
progress when stderr is redirected.</p>
</div></details></section></div></main></body></html>

1
cli/data/progress/fn.progress_bar_supported.html Normal file
View File

@@ -0,0 +1 @@
<!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 `progress_bar_supported` fn in crate `cli`."><title>progress_bar_supported in cli::data::progress - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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="#">progress_bar_supported</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>data::<wbr>progress</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">cli</a>::<wbr><a href="../index.html">data</a>::<wbr><a href="index.html">progress</a></div><h1>Function <span class="fn">progress_<wbr>bar_<wbr>supported</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/cli/data/progress.rs.html#74-81">Source</a> </span></div><pre class="rust item-decl"><code>fn progress_bar_supported(term: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a>&gt;, no_color: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></pre></section></div></main></body></html>

11
cli/data/progress/fn.progress_output_kind.html Normal file
View File

@@ -0,0 +1,11 @@
<!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="Selects the progress output style for `mode` given whether stderr is a TTY and whether the terminal environment is suitable for progress-bar control sequences."><title>progress_output_kind in cli::data::progress - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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="#">progress_output_kind</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>data::<wbr>progress</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">cli</a>::<wbr><a href="../index.html">data</a>::<wbr><a href="index.html">progress</a></div><h1>Function <span class="fn">progress_<wbr>output_<wbr>kind</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/cli/data/progress.rs.html#59-72">Source</a> </span></div><pre class="rust item-decl"><code>pub(crate) fn progress_output_kind(
mode: <a class="enum" href="enum.ProgressMode.html" title="enum cli::data::progress::ProgressMode">ProgressMode</a>,
stderr_is_tty: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
term_supports_progress_bar: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
) -&gt; <a class="enum" href="enum.ProgressOutputKind.html" title="enum cli::data::progress::ProgressOutputKind">ProgressOutputKind</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Selects the progress output style for <code>mode</code> given whether stderr is a TTY
and whether the terminal environment is suitable for progress-bar control
sequences.</p>
<p>The interactive <code>indicatif</code> stderr target hides itself when redirected or
when the terminal is not user-attended, so forced progress falls back to
<a href="struct.LogProgress.html" title="struct cli::data::progress::LogProgress"><code>LogProgress</code></a> instead of a hidden bar in those cases.</p>
</div></details></section></div></main></body></html>

1
cli/data/progress/fn.term_supports_progress_bar.html Normal file
View File

@@ -0,0 +1 @@
<!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 `term_supports_progress_bar` fn in crate `cli`."><title>term_supports_progress_bar in cli::data::progress - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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="#">term_supports_progress_bar</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>data::<wbr>progress</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">cli</a>::<wbr><a href="../index.html">data</a>::<wbr><a href="index.html">progress</a></div><h1>Function <span class="fn">term_<wbr>supports_<wbr>progress_<wbr>bar</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/cli/data/progress.rs.html#83-88">Source</a> </span></div><pre class="rust item-decl"><code>fn term_supports_progress_bar() -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></pre></section></div></main></body></html>

1
cli/data/progress/fn.write_progress_line.html Normal file
View File

@@ -0,0 +1 @@
<!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 `write_progress_line` fn in crate `cli`."><title>write_progress_line in cli::data::progress - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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="#">write_progress_line</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>data::<wbr>progress</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">cli</a>::<wbr><a href="../index.html">data</a>::<wbr><a href="index.html">progress</a></div><h1>Function <span class="fn">write_<wbr>progress_<wbr>line</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/cli/data/progress.rs.html#152-154">Source</a> </span></div><pre class="rust item-decl"><code>fn write_progress_line(line: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></pre></section></div></main></body></html>

14
cli/data/progress/index.html Normal file
View File

@@ -0,0 +1,14 @@
<!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="Minimal internal progress abstraction for Export/Import V2."><title>cli::data::progress - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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 mod"><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="#">Module progress</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module progress</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cli::<wbr>data</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">cli</a>::<wbr><a href="../index.html">data</a></div><h1>Module <span>progress</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/cli/data/progress.rs.html#15-456">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Minimal internal progress abstraction for Export/Import V2.</p>
<p>This is intentionally small and log/internal oriented. It does not touch
stdout and is safe for non-interactive runs. <a href="struct.LogProgress.html" title="struct cli::data::progress::LogProgress"><code>LogProgress</code></a> backs the
import-v2 <code>--progress</code> flag for non-interactive runs by routing events to
stderr, while <a href="struct.IndicatifProgress.html" title="struct cli::data::progress::IndicatifProgress"><code>IndicatifProgress</code></a> renders an interactive bar on a TTY.
Both implement <a href="trait.ProgressReporter.html" title="trait cli::data::progress::ProgressReporter"><code>ProgressReporter</code></a>, so call sites stay agnostic.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.IndicatifProgress.html" title="struct cli::data::progress::IndicatifProgress">Indicatif<wbr>Progress</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A reporter that renders an interactive progress bar via <code>indicatif</code>.</dd><dt><a class="struct" href="struct.LogProgress.html" title="struct cli::data::progress::LogProgress">LogProgress</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A lightweight reporter that logs phase lifecycle and progress through the
stderr. It never touches stdout, so it is safe for non-interactive runs and
keeps dry-run output clean.</dd><dt><a class="struct" href="struct.NoopProgress.html" title="struct cli::data::progress::NoopProgress">Noop<wbr>Progress</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A reporter that discards every event. Used as the production default and in
tests that do not care about progress.</dd><dt><a class="struct" href="struct.PhaseState.html" title="struct cli::data::progress::PhaseState">Phase<wbr>State</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.ProgressPhase.html" title="struct cli::data::progress::ProgressPhase">Progress<wbr>Phase</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>RAII guard for a started progress phase.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ProgressMode.html" title="enum cli::data::progress::ProgressMode">Progress<wbr>Mode</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Controls progress reporting for Export/Import V2.</dd><dt><a class="enum" href="enum.ProgressOutputKind.html" title="enum cli::data::progress::ProgressOutputKind">Progress<wbr>Output<wbr>Kind</a><span title="Restricted Visibility">&nbsp;🔒</span> </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.ProgressReporter.html" title="trait cli::data::progress::ProgressReporter">Progress<wbr>Reporter</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Receives progress events from long-running Export/Import V2 work.</dd></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.build_progress_reporter.html" title="fn cli::data::progress::build_progress_reporter">build_<wbr>progress_<wbr>reporter</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Builds the progress reporter for <code>mode</code>. <code>never</code> is silent; otherwise an
interactive bar is used on TTY stderr, falling back to lightweight log
progress when stderr is redirected.</dd><dt><a class="fn" href="fn.progress_bar_supported.html" title="fn cli::data::progress::progress_bar_supported">progress_<wbr>bar_<wbr>supported</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.progress_output_kind.html" title="fn cli::data::progress::progress_output_kind">progress_<wbr>output_<wbr>kind</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Selects the progress output style for <code>mode</code> given whether stderr is a TTY
and whether the terminal environment is suitable for progress-bar control
sequences.</dd><dt><a class="fn" href="fn.term_supports_progress_bar.html" title="fn cli::data::progress::term_supports_progress_bar">term_<wbr>supports_<wbr>progress_<wbr>bar</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.write_progress_line.html" title="fn cli::data::progress::write_progress_line">write_<wbr>progress_<wbr>line</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>

1
cli/data/progress/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["ProgressMode","ProgressOutputKind"],"fn":["build_progress_reporter","progress_bar_supported","progress_output_kind","term_supports_progress_bar","write_progress_line"],"struct":["IndicatifProgress","LogProgress","NoopProgress","PhaseState","ProgressPhase"],"trait":["ProgressReporter"]};

222
cli/data/progress/struct.IndicatifProgress.html Normal file
View File

File diff suppressed because one or more lines are too long

220
cli/data/progress/struct.LogProgress.html Normal file
View File

File diff suppressed because one or more lines are too long

217
cli/data/progress/struct.NoopProgress.html Normal file
View File

File diff suppressed because one or more lines are too long

219
cli/data/progress/struct.PhaseState.html Normal file
View File

File diff suppressed because one or more lines are too long

224
cli/data/progress/struct.ProgressPhase.html Normal file
View File

File diff suppressed because one or more lines are too long

13
cli/data/progress/trait.ProgressReporter.html Normal file
View File

@@ -0,0 +1,13 @@
<!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="Receives progress events from long-running Export/Import V2 work."><title>ProgressReporter in cli::data::progress - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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 trait"><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="#">ProgressReporter</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Progress<wbr>Reporter</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.finish_phase" title="finish_phase">finish_phase</a></li><li><a href="#tymethod.inc" title="inc">inc</a></li><li><a href="#tymethod.start_phase" title="start_phase">start_phase</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>data::<wbr>progress</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">cli</a>::<wbr><a href="../index.html">data</a>::<wbr><a href="index.html">progress</a></div><h1>Trait <span class="trait">Progress<wbr>Reporter</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/cli/data/progress.rs.html#110-119">Source</a> </span></div><pre class="rust item-decl"><code>pub(crate) trait ProgressReporter: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
// Required methods
fn <a href="#tymethod.start_phase" class="fn">start_phase</a>(&amp;self, name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, total: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>&gt;);
<span class="item-spacer"></span> fn <a href="#tymethod.inc" class="fn">inc</a>(&amp;self, delta: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.finish_phase" class="fn">finish_phase</a>(&amp;self);
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Receives progress events from long-running Export/Import V2 work.</p>
<p>The trait is object-safe so callers can take <code>&amp;dyn ProgressReporter</code> and stay
agnostic about the concrete implementation (no-op in production today, a
recording fake in tests).</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.start_phase" class="method"><a class="src rightside" href="../../../src/cli/data/progress.rs.html#112">Source</a><h4 class="code-header">fn <a href="#tymethod.start_phase" class="fn">start_phase</a>(&amp;self, name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, total: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>&gt;)</h4></section></summary><div class="docblock"><p>Begins a phase with an optional known total number of units.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.inc" class="method"><a class="src rightside" href="../../../src/cli/data/progress.rs.html#115">Source</a><h4 class="code-header">fn <a href="#tymethod.inc" class="fn">inc</a>(&amp;self, delta: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>)</h4></section></summary><div class="docblock"><p>Advances the current phase by <code>delta</code> units.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.finish_phase" class="method"><a class="src rightside" href="../../../src/cli/data/progress.rs.html#118">Source</a><h4 class="code-header">fn <a href="#tymethod.finish_phase" class="fn">finish_phase</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Marks the current phase as finished.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><section id="impl-ProgressReporter-for-IndicatifProgress" class="impl"><a class="src rightside" href="../../../src/cli/data/progress.rs.html#218-265">Source</a><a href="#impl-ProgressReporter-for-IndicatifProgress" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ProgressReporter.html" title="trait cli::data::progress::ProgressReporter">ProgressReporter</a> for <a class="struct" href="struct.IndicatifProgress.html" title="struct cli::data::progress::IndicatifProgress">IndicatifProgress</a></h3></section><section id="impl-ProgressReporter-for-LogProgress" class="impl"><a class="src rightside" href="../../../src/cli/data/progress.rs.html#156-198">Source</a><a href="#impl-ProgressReporter-for-LogProgress" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ProgressReporter.html" title="trait cli::data::progress::ProgressReporter">ProgressReporter</a> for <a class="struct" href="struct.LogProgress.html" title="struct cli::data::progress::LogProgress">LogProgress</a></h3></section><section id="impl-ProgressReporter-for-NoopProgress" class="impl"><a class="src rightside" href="../../../src/cli/data/progress.rs.html#125-129">Source</a><a href="#impl-ProgressReporter-for-NoopProgress" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ProgressReporter.html" title="trait cli::data::progress::ProgressReporter">ProgressReporter</a> for <a class="struct" href="struct.NoopProgress.html" title="struct cli::data::progress::NoopProgress">NoopProgress</a></h3></section></div><script src="../../../trait.impl/cli/data/progress/trait.ProgressReporter.js" async></script></section></div></main></body></html>