rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-01-16 18:22:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ GreptimeTeam/greptimedb@2f4a15ec40 🚀

Browse Source
This commit is contained in:
github-merge-queue[bot]
2025-12-18 14:53:29 +00:00
commit a5293fa691
20217 changed files with 2343087 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
cli/common/index.html Normal file
View File

File diff suppressed because one or more lines are too long

2
cli/common/object_store/fn.new_fs_object_store.html Normal file
View File

@@ -0,0 +1,2 @@
<!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="Creates a new file system object store."><title>new_fs_object_store in cli::common::object_store - 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="cli" 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="sidebar-items.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 fn"><!--[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="#">new_fs_object_store</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>common::<wbr>object_<wbr>store</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">cli</a>::<wbr><a href="../index.html">common</a>::<wbr><a href="index.html">object_store</a></div><h1>Function <span class="fn">new_<wbr>fs_<wbr>object_<wbr>store</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/common/object_store.rs.html#398-406">Source</a> </span></div><pre class="rust item-decl"><code>pub fn new_fs_object_store(root: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;ObjectStore, BoxedError&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a new file system object store.</p>
</div></details></section></div></main></body></html>

3
cli/common/object_store/index.html Normal file
View File

File diff suppressed because one or more lines are too long

11
cli/common/object_store/macro.gen_object_store_builder!.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=macro.gen_object_store_builder.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="macro.gen_object_store_builder.html">macro.gen_object_store_builder.html</a>...</p>
<script>location.replace("macro.gen_object_store_builder.html" + location.search + location.hash);</script>
</body>
</html>

3
cli/common/object_store/macro.gen_object_store_builder.html Normal file
View File

@@ -0,0 +1,3 @@
<!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 `gen_object_store_builder` macro in crate `cli`."><title>gen_object_store_builder in cli::common::object_store - 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="cli" 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="sidebar-items.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 macro"><!--[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="#">gen_object_store_builder</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>common::<wbr>object_<wbr>store</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">cli</a>::<wbr><a href="../index.html">common</a>::<wbr><a href="index.html">object_store</a></div><h1>Macro <span class="macro">gen_<wbr>object_<wbr>store_<wbr>builder</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/common/object_store.rs.html#408-427">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! gen_object_store_builder {
($method:ident, $field:ident, $conn_type:ty, $service_type:ty) =&gt; { ... };
}</code></pre></section></div></main></body></html>

11
cli/common/object_store/macro.validate_backend!.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=macro.validate_backend.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="macro.validate_backend.html">macro.validate_backend.html</a>...</p>
<script>location.replace("macro.validate_backend.html" + location.search + location.hash);</script>
</body>
</html>

35
cli/common/object_store/macro.validate_backend.html Normal file
View File

@@ -0,0 +1,35 @@
<!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="Macro for declarative backend validation."><title>validate_backend in cli::common::object_store - 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="cli" 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="sidebar-items.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 macro"><!--[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="#">validate_backend</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">validate_<wbr>backend</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#validation-rules" title="Validation Rules">Validation Rules</a></li><li><a href="#syntax" title="Syntax">Syntax</a></li><li><a href="#arguments" title="Arguments">Arguments</a></li><li><a href="#example" title="Example">Example</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>common::<wbr>object_<wbr>store</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">cli</a>::<wbr><a href="../index.html">common</a>::<wbr><a href="index.html">object_store</a></div><h1>Macro <span class="macro">validate_<wbr>backend</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/common/object_store.rs.html#154-192">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! validate_backend {
(
enable: $enable:expr,
name: $backend_name:expr,
required: [ $( ($field:expr, $field_name:expr) ),* $(,)? ]
$(, custom_validator: $custom_validator:expr)?
) =&gt; { ... };
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Macro for declarative backend validation.</p>
<h2 id="validation-rules"><a class="doc-anchor" href="#validation-rules">§</a>Validation Rules</h2>
<p>For each storage backend (S3, OSS, GCS, Azblob), this function validates:
<strong>When backend is enabled</strong> (e.g., <code>--s3</code>): All required fields must be non-empty</p>
<p>Note: When backend is disabled, clap’s <code>requires</code> attribute ensures no configuration
fields can be provided at parse time.</p>
<h2 id="syntax"><a class="doc-anchor" href="#syntax">§</a>Syntax</h2>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="macro">validate_backend!</span>(
enable: <span class="self">self</span>.enable_s3,
name: <span class="string">"S3"</span>,
required: [(field1, <span class="string">"name1"</span>), (field2, <span class="string">"name2"</span>), ...],
custom_validator: |missing| { ... } <span class="comment">// optional
</span>)</code></pre></div><h2 id="arguments"><a class="doc-anchor" href="#arguments">§</a>Arguments</h2>
<ul>
<li><code>enable</code>: Boolean expression indicating if backend is enabled</li>
<li><code>name</code>: Human-readable backend name for error messages</li>
<li><code>required</code>: Array of (field_ref, field_name) tuples for required fields</li>
<li><code>custom_validator</code>: Optional closure for complex validation logic</li>
</ul>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="macro">validate_backend!</span>(
enable: <span class="self">self</span>.enable_s3,
name: <span class="string">"S3"</span>,
required: [
(<span class="kw-2">&amp;</span><span class="self">self</span>.s3.s3_bucket, <span class="string">"bucket"</span>),
(<span class="kw-2">&amp;</span><span class="self">self</span>.s3.s3_access_key_id, <span class="string">"access key ID"</span>),
]
)</code></pre></div></div></details></section></div></main></body></html>

11
cli/common/object_store/macro.wrap_with_clap_prefix!.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=macro.wrap_with_clap_prefix.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="macro.wrap_with_clap_prefix.html">macro.wrap_with_clap_prefix.html</a>...</p>
<script>location.replace("macro.wrap_with_clap_prefix.html" + location.search + location.hash);</script>
</body>
</html>

7
cli/common/object_store/macro.wrap_with_clap_prefix.html Normal file
View File

@@ -0,0 +1,7 @@
<!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 `wrap_with_clap_prefix` macro in crate `cli`."><title>wrap_with_clap_prefix in cli::common::object_store - 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="cli" 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="sidebar-items.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 macro"><!--[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="#">wrap_with_clap_prefix</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>common::<wbr>object_<wbr>store</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">cli</a>::<wbr><a href="../index.html">common</a>::<wbr><a href="index.html">object_store</a></div><h1>Macro <span class="macro">wrap_<wbr>with_<wbr>clap_<wbr>prefix</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/common/object_store.rs.html#85-112">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! wrap_with_clap_prefix {
(
$new_name:ident, $prefix:literal, $enable_flag:literal, $base:ty, {
$( $( #[doc = $doc:expr] )? $( #[alias = $alias:literal] )? $field:ident : $type:ty $( = $default:expr )? ),* $(,)?
}
) =&gt; { ... };
}</code></pre></section></div></main></body></html>

1
cli/common/object_store/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"fn":["new_fs_object_store"],"macro":["gen_object_store_builder","validate_backend","wrap_with_clap_prefix"],"struct":["ObjectStoreConfig","PrefixedAzblobConnection","PrefixedGcsConnection","PrefixedOssConnection","PrefixedS3Connection"],"trait":["FieldValidator","IntoField"]};

248
cli/common/object_store/struct.ObjectStoreConfig.html Normal file
View File

File diff suppressed because one or more lines are too long

238
cli/common/object_store/struct.PrefixedAzblobConnection.html Normal file
View File

File diff suppressed because one or more lines are too long

238
cli/common/object_store/struct.PrefixedGcsConnection.html Normal file
View File

File diff suppressed because one or more lines are too long

236
cli/common/object_store/struct.PrefixedOssConnection.html Normal file
View File

File diff suppressed because one or more lines are too long

242
cli/common/object_store/struct.PrefixedS3Connection.html Normal file
View File

File diff suppressed because one or more lines are too long

16
cli/common/object_store/trait.FieldValidator.html Normal file
View File

@@ -0,0 +1,16 @@
<!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="Trait for checking if a field is effectively empty."><title>FieldValidator in cli::common::object_store - 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="cli" 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="sidebar-items.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 trait"><!--[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="#">FieldValidator</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Field<wbr>Validator</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_empty" title="is_empty">is_empty</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-FieldValidator-for-Option%3CSecretBox%3CString%3E%3E" title="Option&#60;SecretString&#62;">Option&#60;SecretString&#62;</a></li><li><a href="#impl-FieldValidator-for-Option%3CString%3E" title="Option&#60;String&#62;">Option&#60;String&#62;</a></li><li><a href="#impl-FieldValidator-for-String" title="String">String</a></li><li><a href="#impl-FieldValidator-for-bool" title="bool">bool</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>common::<wbr>object_<wbr>store</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">cli</a>::<wbr><a href="../index.html">common</a>::<wbr><a href="index.html">object_store</a></div><h1>Trait <span class="trait">Field<wbr>Validator</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/common/object_store.rs.html#51-54">Source</a> </span></div><pre class="rust item-decl"><code>trait FieldValidator {
// Required method
fn <a href="#tymethod.is_empty" class="fn">is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/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>Trait for checking if a field is effectively empty.</p>
<p><strong><code>is_empty()</code></strong>: Checks if the field has no meaningful value</p>
<ul>
<li>Used when backend is enabled to validate required fields</li>
<li><code>None</code>, <code>Some("")</code>, <code>false</code>, or <code>""</code> are considered empty</li>
</ul>
</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.is_empty" class="method"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#53">Source</a><h4 class="code-header">fn <a href="#tymethod.is_empty" class="fn">is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Check if the field is empty (has no meaningful value).</p>
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-FieldValidator-for-Option%3CString%3E" class="impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#71-75">Source</a><a href="#impl-FieldValidator-for-Option%3CString%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FieldValidator.html" title="trait cli::common::object_store::FieldValidator">FieldValidator</a> for <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="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;</h3><div class="docblock"><p>Option<String> fields: None or empty content is empty</p>
</div></section></summary><div class="impl-items"><section id="method.is_empty" class="method trait-impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#72-74">Source</a><a href="#method.is_empty" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_empty" class="fn">is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-FieldValidator-for-Option%3CSecretBox%3CString%3E%3E" class="impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#79-83">Source</a><a href="#impl-FieldValidator-for-Option%3CSecretBox%3CString%3E%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FieldValidator.html" title="trait cli::common::object_store::FieldValidator">FieldValidator</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;SecretString&gt;</h3><div class="docblock"><p>Option<SecretString> fields: None or empty secret is empty
For secrets, Some(“”) is treated as “not provided” for both checks</p>
</div></section></summary><div class="impl-items"><section id="method.is_empty-1" class="method trait-impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#80-82">Source</a><a href="#method.is_empty-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_empty" class="fn">is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-FieldValidator-for-bool" class="impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#64-68">Source</a><a href="#impl-FieldValidator-for-bool" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FieldValidator.html" title="trait cli::common::object_store::FieldValidator">FieldValidator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h3><div class="docblock"><p>Bool fields: false is considered “empty”, true is “provided”</p>
</div></section></summary><div class="impl-items"><section id="method.is_empty-2" class="method trait-impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#65-67">Source</a><a href="#method.is_empty-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_empty" class="fn">is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-FieldValidator-for-String" class="impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#57-61">Source</a><a href="#impl-FieldValidator-for-String" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FieldValidator.html" title="trait cli::common::object_store::FieldValidator">FieldValidator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h3><div class="docblock"><p>String fields: empty if the string is empty</p>
</div></section></summary><div class="impl-items"><section id="method.is_empty-3" class="method trait-impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#58-60">Source</a><a href="#method.is_empty-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_empty" class="fn">is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../trait.impl/cli/common/object_store/trait.FieldValidator.js" data-ignore-extern-crates="alloc,std,core" async></script></section></div></main></body></html>

9
cli/common/object_store/trait.IntoField.html Normal file
View File

@@ -0,0 +1,9 @@
<!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="Trait to convert CLI field types to target struct field types. This enables `Option&#60;SecretString&#62;` (CLI) -&#62; `SecretString` (target) conversions, allowing us to distinguish “not provided” from “provided but empty”."><title>IntoField in cli::common::object_store - 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="cli" 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="sidebar-items.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 trait"><!--[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="#">IntoField</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Into<wbr>Field</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.into_field" title="into_field">into_field</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-IntoField%3CSecretBox%3CString%3E%3E-for-Option%3CSecretBox%3CString%3E%3E" title="Option&#60;SecretString&#62;">Option&#60;SecretString&#62;</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cli::<wbr>common::<wbr>object_<wbr>store</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">cli</a>::<wbr><a href="../index.html">common</a>::<wbr><a href="index.html">object_store</a></div><h1>Trait <span class="trait">Into<wbr>Field</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/common/object_store.rs.html#28-30">Source</a> </span></div><pre class="rust item-decl"><code>trait IntoField&lt;T&gt; {
// Required method
fn <a href="#tymethod.into_field" class="fn">into_field</a>(self) -&gt; T;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait to convert CLI field types to target struct field types.
This enables <code>Option&lt;SecretString&gt;</code> (CLI) -&gt; <code>SecretString</code> (target) conversions,
allowing us to distinguish “not provided” from “provided but empty”.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.into_field" class="method"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#29">Source</a><h4 class="code-header">fn <a href="#tymethod.into_field" class="fn">into_field</a>(self) -&gt; T</h4></section></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-IntoField%3CSecretBox%3CString%3E%3E-for-Option%3CSecretBox%3CString%3E%3E" class="impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#40-44">Source</a><a href="#impl-IntoField%3CSecretBox%3CString%3E%3E-for-Option%3CSecretBox%3CString%3E%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoField.html" title="trait cli::common::object_store::IntoField">IntoField</a>&lt;SecretBox&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;&gt; for <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;SecretString&gt;</h3><div class="docblock"><p>Convert <code>Option&lt;SecretString&gt;</code> to <code>SecretString</code>, using default for None.</p>
</div></section></summary><div class="impl-items"><section id="method.into_field" class="method trait-impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#41-43">Source</a><a href="#method.into_field" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_field" class="fn">into_field</a>(self) -&gt; SecretString</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-IntoField%3CT%3E-for-T" class="impl"><a class="src rightside" href="../../../src/cli/common/object_store.rs.html#33-37">Source</a><a href="#impl-IntoField%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.IntoField.html" title="trait cli::common::object_store::IntoField">IntoField</a>&lt;T&gt; for T</h3><div class="docblock"><p>Identity conversion for types that are the same.</p>
</div></section></div><script src="../../../trait.impl/cli/common/object_store/trait.IntoField.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html>

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

@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"mod":["object_store","store"]};

1
cli/common/store/index.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 `store` mod in crate `cli`."><title>cli::common::store - 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="cli" 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="../sidebar-items.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"><!--[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 store</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cli/index.html">cli</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module store</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cli::<wbr>common</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">cli</a>::<wbr><a href="../index.html">common</a></div><h1>Module <span>store</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/common/store.rs.html#15-181">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.StoreConfig.html" title="struct cli::common::store::StoreConfig">Store<wbr>Config</a></dt></dl></section></div></main></body></html>

1
cli/common/store/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["StoreConfig"]};

245
cli/common/store/struct.StoreConfig.html Normal file
View File

File diff suppressed because one or more lines are too long