mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-07-04 13:00:38 +00:00
14 lines
8.0 KiB
HTML
14 lines
8.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="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> <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"> 🔒</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"> 🔒</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"> 🔒</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"> 🔒</span> </dt><dt><a class="struct" href="struct.ProgressPhase.html" title="struct cli::data::progress::ProgressPhase">Progress<wbr>Phase</a><span title="Restricted Visibility"> 🔒</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"> 🔒</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"> 🔒</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"> 🔒</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"> 🔒</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"> 🔒</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"> 🔒</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"> 🔒</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"> 🔒</span> </dt></dl></section></div></main></body></html> |