Files
greptimedb/cli/common/object_store/index.html
2025-12-24 05:00:45 +00:00

3 lines
6.1 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="API documentation for the Rust `object_store` mod in crate `cli`."><title>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 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 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"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module object_<wbr>store</a></h2><h3><a href="#macros">Module Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</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>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>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#15-470">Source</a> </span></div><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.gen_object_store_builder.html" title="macro cli::common::object_store::gen_object_store_builder">gen_<wbr>object_<wbr>store_<wbr>builder</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="macro" href="macro.validate_backend.html" title="macro cli::common::object_store::validate_backend">validate_<wbr>backend</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Macro for declarative backend validation.</dd><dt><a class="macro" href="macro.wrap_with_clap_prefix.html" title="macro cli::common::object_store::wrap_with_clap_prefix">wrap_<wbr>with_<wbr>clap_<wbr>prefix</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.ObjectStoreConfig.html" title="struct cli::common::object_store::ObjectStoreConfig">Object<wbr>Store<wbr>Config</a></dt><dd>Common config for object store.</dd><dt><a class="struct" href="struct.PrefixedAzblobConnection.html" title="struct cli::common::object_store::PrefixedAzblobConnection">Prefixed<wbr>Azblob<wbr>Connection</a></dt><dt><a class="struct" href="struct.PrefixedGcsConnection.html" title="struct cli::common::object_store::PrefixedGcsConnection">Prefixed<wbr>GcsConnection</a></dt><dt><a class="struct" href="struct.PrefixedOssConnection.html" title="struct cli::common::object_store::PrefixedOssConnection">Prefixed<wbr>OssConnection</a></dt><dt><a class="struct" href="struct.PrefixedS3Connection.html" title="struct cli::common::object_store::PrefixedS3Connection">Prefixed<wbr>S3Connection</a></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.FieldValidator.html" title="trait cli::common::object_store::FieldValidator">Field<wbr>Validator</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Trait for checking if a field is effectively empty.</dd><dt><a class="trait" href="trait.IntoField.html" title="trait cli::common::object_store::IntoField">Into<wbr>Field</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>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”.</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.new_fs_object_store.html" title="fn cli::common::object_store::new_fs_object_store">new_<wbr>fs_<wbr>object_<wbr>store</a></dt><dd>Creates a new file system object store.</dd></dl></section></div></main></body></html>