Files
greptimedb/common_datasource/object_store/index.html
T

2 lines
8.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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 `common_datasource`."><title>common_datasource::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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_datasource" 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 object_store</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_datasource/index.html">common_<wbr>datasource</a><span class="version">1.3.0-alpha.1</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="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</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 common_<wbr>datasource</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">common_datasource</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/common_datasource/object_store.rs.html#15-767">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="azblob/index.html" title="mod common_datasource::object_store::azblob">azblob</a></dt><dt><a class="mod" href="fs/index.html" title="mod common_datasource::object_store::fs">fs</a></dt><dt><a class="mod" href="gcs/index.html" title="mod common_datasource::object_store::gcs">gcs</a></dt><dt><a class="mod" href="oss/index.html" title="mod common_datasource::object_store::oss">oss</a></dt><dt><a class="mod" href="s3/index.html" title="mod common_datasource::object_store::s3">s3</a></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.BuiltBackend.html" title="struct common_datasource::object_store::BuiltBackend">Built<wbr>Backend</a></dt><dd>An object store rooted at the targets parent, together with the optional
target path relative to that root.</dd><dt><a class="struct" href="struct.DISK_SYMBOL_PATTERN.html" title="struct common_datasource::object_store::DISK_SYMBOL_PATTERN">DISK_<wbr>SYMBOL_<wbr>PATTERN</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.LocalFileRoot.html" title="struct common_datasource::object_store::LocalFileRoot">Local<wbr>File<wbr>Root</a></dt><dd>An opened server-controlled root for sandboxed SQL file access.</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.LocalFileAccess.html" title="enum common_datasource::object_store::LocalFileAccess">Local<wbr>File<wbr>Access</a></dt><dd>Controls whether SQL paths may access the local filesystem.</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_SCHEMA.html" title="constant common_datasource::object_store::AZBLOB_SCHEMA">AZBLOB_<wbr>SCHEMA</a></dt><dt><a class="constant" href="constant.FILE_SCHEMA.html" title="constant common_datasource::object_store::FILE_SCHEMA">FILE_<wbr>SCHEMA</a></dt><dt><a class="constant" href="constant.FS_SCHEMA.html" title="constant common_datasource::object_store::FS_SCHEMA">FS_<wbr>SCHEMA</a></dt><dt><a class="constant" href="constant.GCS_SCHEMA.html" title="constant common_datasource::object_store::GCS_SCHEMA">GCS_<wbr>SCHEMA</a></dt><dt><a class="constant" href="constant.OSS_SCHEMA.html" title="constant common_datasource::object_store::OSS_SCHEMA">OSS_<wbr>SCHEMA</a></dt><dt><a class="constant" href="constant.S3_SCHEMA.html" title="constant common_datasource::object_store::S3_SCHEMA">S3_<wbr>SCHEMA</a></dt></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_backend.html" title="fn common_datasource::object_store::build_backend">build_<wbr>backend</a></dt><dt><a class="fn" href="fn.build_backend_for_write.html" title="fn common_datasource::object_store::build_backend_for_write">build_<wbr>backend_<wbr>for_<wbr>write</a></dt><dd>Builds a backend for an operation that may create the target directory.</dd><dt><a class="fn" href="fn.build_backend_for_write_with_path.html" title="fn common_datasource::object_store::build_backend_for_write_with_path">build_<wbr>backend_<wbr>for_<wbr>write_<wbr>with_<wbr>path</a></dt><dd>Builds a writable backend and returns the target path relative to the backend root.</dd><dt><a class="fn" href="fn.build_backend_inner.html" title="fn common_datasource::object_store::build_backend_inner">build_<wbr>backend_<wbr>inner</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.build_backend_with_path.html" title="fn common_datasource::object_store::build_backend_with_path">build_<wbr>backend_<wbr>with_<wbr>path</a></dt><dd>Builds a backend and returns the target path relative to the backend root.</dd><dt><a class="fn" href="fn.configured_local_path.html" title="fn common_datasource::object_store::configured_local_path">configured_<wbr>local_<wbr>path</a></dt><dd>Converts a configured location into a local path.</dd><dt><a class="fn" href="fn.handle_windows_path.html" title="fn common_datasource::object_store::handle_windows_path">handle_<wbr>windows_<wbr>path</a></dt><dt><a class="fn" href="fn.normalize_untrusted_path.html" title="fn common_datasource::object_store::normalize_untrusted_path">normalize_<wbr>untrusted_<wbr>path</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.parse_url.html" title="fn common_datasource::object_store::parse_url">parse_<wbr>url</a></dt><dd>Returns <code>(schema, Option&lt;host&gt;, path)</code></dd><dt><a class="fn" href="fn.strip_local_prefix.html" title="fn common_datasource::object_store::strip_local_prefix">strip_<wbr>local_<wbr>prefix</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>