mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-08 14:22:58 +00:00
16 lines
10 KiB
HTML
16 lines
10 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="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.4</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<SecretString>">Option<SecretString></a></li><li><a href="#impl-FieldValidator-for-Option%3CString%3E" title="Option<String>">Option<String></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> <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>(&self) -> <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>(&self) -> <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><<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>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>(&self) -> <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><SecretString></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>(&self) -> <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>(&self) -> <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>(&self) -> <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> |