greptimedb/object_store/services/index.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="Service builders enabled through `services-*` Cargo features."><title>object_store::services - 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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="object_store" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.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-417ebf0a.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 services</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../object_store/index.html">object_<wbr>store</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module services</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="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate 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" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">object_store</a></div><h1>Module <span>services</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"></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Service builders enabled through <code>services-*</code> Cargo features.</p>
<p><a href="struct.Memory.html" title="struct object_store::services::Memory"><code>Memory</code></a> is always available. Other builders are
re-exported when their matching facade feature is enabled; for example,
<code>services-s3</code> enables <a href="struct.S3.html" title="struct object_store::services::S3"><code>S3</code></a>.</p>
<p>Pass a configured builder to <a href="../struct.ObjectStore.html#method.new" title="associated function object_store::ObjectStore::new"><code>Operator::new</code></a>. The facade automatically
registers enabled services for <a href="../struct.ObjectStore.html#method.from_uri" title="associated function object_store::ObjectStore::from_uri"><code>Operator::from_uri</code></a> and
<a href="../struct.ObjectStore.html#method.via_iter" title="associated function object_store::ObjectStore::via_iter"><code>Operator::via_iter</code></a> when the <code>auto-register-services</code> feature is enabled.</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.Azblob.html" title="struct object_store::services::Azblob">Azblob</a></dt><dd>Capabilities</dd><dt><a class="struct" href="struct.AzblobConfig.html" title="struct object_store::services::AzblobConfig">Azblob<wbr>Config</a></dt><dd>Azure Storage Blob services support.</dd><dt><a class="struct" href="struct.Fs.html" title="struct object_store::services::Fs">Fs</a></dt><dd>POSIX file system support.</dd><dt><a class="struct" href="struct.FsConfig.html" title="struct object_store::services::FsConfig">FsConfig</a></dt><dd>config for file system</dd><dt><a class="struct" href="struct.Gcs.html" title="struct object_store::services::Gcs">Gcs</a></dt><dd><a href="https://cloud.google.com/storage">Google Cloud Storage</a> services support.</dd><dt><a class="struct" href="struct.GcsConfig.html" title="struct object_store::services::GcsConfig">GcsConfig</a></dt><dd><a href="https://cloud.google.com/storage">Google Cloud Storage</a> services support.</dd><dt><a class="struct" href="struct.HdfsNative.html" title="struct object_store::services::HdfsNative">Hdfs<wbr>Native</a></dt><dd><a href="https://hadoop.apache.org/">Hadoop Distributed File System (HDFS™)</a> support.
Using <a href="https://github.com/Kimahriman/hdfs-native">Native Rust HDFS client</a>.
A distributed file system that provides high-throughput access to application data.
Using <a href="https://github.com/Kimahriman/hdfs-native">Native Rust HDFS client</a>.</dd><dt><a class="struct" href="struct.HdfsNativeConfig.html" title="struct object_store::services::HdfsNativeConfig">Hdfs<wbr>Native<wbr>Config</a></dt><dd>Config for HdfsNative services support.</dd><dt><a class="struct" href="struct.Http.html" title="struct object_store::services::Http">Http</a></dt><dd>HTTP Read-only service support like <a href="https://www.nginx.com/">Nginx</a> and <a href="https://caddyserver.com/">Caddy</a>.</dd><dt><a class="struct" href="struct.HttpConfig.html" title="struct object_store::services::HttpConfig">Http<wbr>Config</a></dt><dd>Config for Http service support.</dd><dt><a class="struct" href="struct.Memory.html" title="struct object_store::services::Memory">Memory</a></dt><dd>In memory service support. (BTreeMap Based)</dd><dt><a class="struct" href="struct.MemoryConfig.html" title="struct object_store::services::MemoryConfig">Memory<wbr>Config</a></dt><dd>Config for memory.</dd><dt><a class="struct" href="struct.Oss.html" title="struct object_store::services::Oss">Oss</a></dt><dd>Aliyun Object Storage Service (OSS) support</dd><dt><a class="struct" href="struct.OssConfig.html" title="struct object_store::services::OssConfig">OssConfig</a></dt><dd>Config for Aliyun Object Storage Service (OSS) support.</dd><dt><a class="struct" href="struct.S3.html" title="struct object_store::services::S3">S3</a></dt><dd>Aws S3 and compatible services (including minio, digitalocean space, Tencent Cloud Object Storage(COS) and so on) support.
For more information about s3-compatible services, refer to <a href="#compatible-services">Compatible Services</a>.</dd><dt><a class="struct" href="struct.S3Config.html" title="struct object_store::services::S3Config">S3Config</a></dt><dd>Config for Aws S3 and compatible services (including minio, digitalocean space,
Tencent Cloud Object Storage(COS) and so on) support.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.AZBLOB_SCHEME.html" title="constant object_store::services::AZBLOB_SCHEME">AZBLOB_<wbr>SCHEME</a></dt><dd>URI scheme used for service registration and scheme-driven construction.</dd><dt><a class="constant" href="constant.FILE_SCHEME.html" title="constant object_store::services::FILE_SCHEME">FILE_<wbr>SCHEME</a></dt><dd>Alias scheme for fs service that follows the standard URI scheme.</dd><dt><a class="constant" href="constant.FS_SCHEME.html" title="constant object_store::services::FS_SCHEME">FS_<wbr>SCHEME</a></dt><dd>URI scheme used for service registration and scheme-driven construction.</dd><dt><a class="constant" href="constant.GCS_SCHEME.html" title="constant object_store::services::GCS_SCHEME">GCS_<wbr>SCHEME</a></dt><dd>URI scheme used for service registration and scheme-driven construction.</dd><dt><a class="constant" href="constant.HDFS_NATIVE_SCHEME.html" title="constant object_store::services::HDFS_NATIVE_SCHEME">HDFS_<wbr>NATIVE_<wbr>SCHEME</a></dt><dd>URI scheme used for service registration and scheme-driven construction.</dd><dt><a class="constant" href="constant.HTTPS_SCHEME.html" title="constant object_store::services::HTTPS_SCHEME">HTTPS_<wbr>SCHEME</a></dt><dd>Alias URI scheme used for HTTPS connections.</dd><dt><a class="constant" href="constant.HTTP_SCHEME.html" title="constant object_store::services::HTTP_SCHEME">HTTP_<wbr>SCHEME</a></dt><dd>URI scheme used for service registration and scheme-driven construction.</dd><dt><a class="constant" href="constant.MEMORY_SCHEME.html" title="constant object_store::services::MEMORY_SCHEME">MEMORY_<wbr>SCHEME</a></dt><dd>URI scheme used for memory service registration and URI construction.</dd><dt><a class="constant" href="constant.OSS_SCHEME.html" title="constant object_store::services::OSS_SCHEME">OSS_<wbr>SCHEME</a></dt><dd>URI scheme used for service registration and scheme-driven construction.</dd><dt><a class="constant" href="constant.S3_SCHEME.html" title="constant object_store::services::S3_SCHEME">S3_<wbr>SCHEME</a></dt><dd>URI scheme used for service registration and scheme-driven construction.</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.register_azblob_service.html" title="fn object_store::services::register_azblob_service">register_<wbr>azblob_<wbr>service</a></dt><dd>Register this service’s URI scheme or schemes with an operator registry.</dd><dt><a class="fn" href="fn.register_fs_service.html" title="fn object_store::services::register_fs_service">register_<wbr>fs_<wbr>service</a></dt><dd>Register this service’s URI scheme or schemes with an operator registry.</dd><dt><a class="fn" href="fn.register_gcs_service.html" title="fn object_store::services::register_gcs_service">register_<wbr>gcs_<wbr>service</a></dt><dd>Register this service’s URI scheme or schemes with an operator registry.</dd><dt><a class="fn" href="fn.register_hdfs_native_service.html" title="fn object_store::services::register_hdfs_native_service">register_<wbr>hdfs_<wbr>native_<wbr>service</a></dt><dd>Register this service’s URI scheme or schemes with an operator registry.</dd><dt><a class="fn" href="fn.register_http_service.html" title="fn object_store::services::register_http_service">register_<wbr>http_<wbr>service</a></dt><dd>Register this service’s URI scheme or schemes with an operator registry.</dd><dt><a class="fn" href="fn.register_memory_service.html" title="fn object_store::services::register_memory_service">register_<wbr>memory_<wbr>service</a></dt><dd>Register the memory URI scheme with an operator registry.</dd><dt><a class="fn" href="fn.register_oss_service.html" title="fn object_store::services::register_oss_service">register_<wbr>oss_<wbr>service</a></dt><dd>Register this service’s URI scheme or schemes with an operator registry.</dd><dt><a class="fn" href="fn.register_s3_service.html" title="fn object_store::services::register_s3_service">register_<wbr>s3_<wbr>service</a></dt><dd>Register this service’s URI scheme or schemes with an operator registry.</dd></dl></section></div></main></body></html>