mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-09 06:42:57 +00:00
5 lines
13 KiB
HTML
5 lines
13 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` crate."><title>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="object_store" 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="../crates.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 crate"><!--[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="#">Crate object_store</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.0.0-beta.4</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><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="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>object_<wbr>store</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/object_store/lib.rs.html#15-37">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.AzblobConnection"><code>pub use config::<a class="struct" href="config/struct.AzblobConnection.html" title="struct object_store::config::AzblobConnection">AzblobConnection</a>;</code></dt><dt id="reexport.GcsConnection"><code>pub use config::<a class="struct" href="config/struct.GcsConnection.html" title="struct object_store::config::GcsConnection">GcsConnection</a>;</code></dt><dt id="reexport.OssConnection"><code>pub use config::<a class="struct" href="config/struct.OssConnection.html" title="struct object_store::config::OssConnection">OssConnection</a>;</code></dt><dt id="reexport.S3Connection"><code>pub use config::<a class="struct" href="config/struct.S3Connection.html" title="struct object_store::config::S3Connection">S3Connection</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="config/index.html" title="mod object_store::config">config</a></dt><dt><a class="mod" href="error/index.html" title="mod object_store::error">error</a></dt><dt><a class="mod" href="factory/index.html" title="mod object_store::factory">factory</a></dt><dt><a class="mod" href="layers/index.html" title="mod object_store::layers">layers</a></dt><dt><a class="mod" href="manager/index.html" title="mod object_store::manager">manager</a></dt><dt><a class="mod" href="metrics/index.html" title="mod object_store::metrics">metrics</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>object-store metrics</dd><dt><a class="mod" href="services/index.html" title="mod object_store::services">services</a></dt><dd>Services will provide builders to build underlying backends.</dd><dt><a class="mod" href="test_util/index.html" title="mod object_store::test_util">test_<wbr>util</a></dt><dt><a class="mod" href="util/index.html" title="mod object_store::util">util</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.Buffer.html" title="struct object_store::Buffer">Buffer</a></dt><dd>Buffer is a wrapper of contiguous <code>Bytes</code> and non-contiguous <code>[Bytes]</code>.</dd><dt><a class="struct" href="struct.Entry.html" title="struct object_store::Entry">Entry</a></dt><dd>Entry returned by <a href="struct.Lister.html" title="struct object_store::Lister"><code>Lister</code></a> or [<code>BlockingLister</code>] to represent a path and it’s relative metadata.</dd><dt><a class="struct" href="struct.Error.html" title="struct object_store::Error">Error</a></dt><dd>Error is the error struct returned by all opendal functions.</dd><dt><a class="struct" href="struct.FuturesAsyncReader.html" title="struct object_store::FuturesAsyncReader">Futures<wbr>Async<wbr>Reader</a></dt><dd>FuturesAsyncReader is the adapter of [<code>AsyncRead</code>], [<code>AsyncBufRead</code>]
|
||
and [<code>AsyncSeek</code>] generated by <a href="struct.Reader.html#method.into_futures_async_read" title="method object_store::Reader::into_futures_async_read"><code>Reader::into_futures_async_read</code></a>.</dd><dt><a class="struct" href="struct.FuturesAsyncWriter.html" title="struct object_store::FuturesAsyncWriter">Futures<wbr>Async<wbr>Writer</a></dt><dd>FuturesIoAsyncWriter is the adapter of [<code>AsyncWrite</code>] for <a href="struct.Writer.html" title="struct object_store::Writer"><code>Writer</code></a>.</dd><dt><a class="struct" href="struct.HttpClient.html" title="struct object_store::HttpClient">Http<wbr>Client</a></dt><dd>A HTTP client instance for OpenDAL’s services.</dd><dt><a class="struct" href="struct.Lister.html" title="struct object_store::Lister">Lister</a></dt><dd>Lister is designed to list entries at given path in an asynchronous
|
||
manner.</dd><dt><a class="struct" href="struct.ObjectStore.html" title="struct object_store::ObjectStore">Object<wbr>Store</a></dt><dd>The <code>Operator</code> serves as the entry point for all public asynchronous APIs.</dd><dt><a class="struct" href="struct.Reader.html" title="struct object_store::Reader">Reader</a></dt><dd>Reader is designed to read data from given path in an asynchronous
|
||
manner.</dd><dt><a class="struct" href="struct.Writer.html" title="struct object_store::Writer">Writer</a></dt><dd>Writer is designed to write data into given path in an asynchronous
|
||
manner.</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.EntryMode.html" title="enum object_store::EntryMode">Entry<wbr>Mode</a></dt><dd>EntryMode represents the mode.</dd><dt><a class="enum" href="enum.ErrorKind.html" title="enum object_store::ErrorKind">Error<wbr>Kind</a></dt><dd>ErrorKind is all kinds of Error of opendal.</dd><dt><a class="enum" href="enum.Scheme.html" title="enum object_store::Scheme">Scheme</a></dt><dd>Services that OpenDAL supports</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.ATOMIC_WRITE_DIR.html" title="constant object_store::ATOMIC_WRITE_DIR">ATOMIC_<wbr>WRITE_<wbr>DIR</a></dt><dt><a class="constant" href="constant.OBJECT_CACHE_DIR.html" title="constant object_store::OBJECT_CACHE_DIR">OBJECT_<wbr>CACHE_<wbr>DIR</a></dt><dd>The default object cache directory name.</dd><dt><a class="constant" href="constant.OLD_ATOMIC_WRITE_DIR.html" title="constant object_store::OLD_ATOMIC_WRITE_DIR">OLD_<wbr>ATOMIC_<wbr>WRITE_<wbr>DIR</a></dt><dd>For compatibility. Remove this after a major version release.</dd></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.Access.html" title="trait object_store::Access">Access</a></dt><dd>Underlying trait of all backends for implementers.</dd><dt><a class="trait" href="trait.ObjectStoreBuilder.html" title="trait object_store::ObjectStoreBuilder">Object<wbr>Store<wbr>Builder</a></dt><dd>Builder is used to set up underlying services.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.Result.html" title="type object_store::Result">Result</a></dt><dd>Result that is a wrapper of <code>Result<T, opendal::Error></code></dd></dl><script type="text/json" id="notable-traits-data">{"&[u8]":"<h3>Notable traits for <code>&[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</div>","<Arc<S> as Service<Request>>::Future":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></div>","<Arc<W> as MakeWriter<'a>>::Writer":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></div>","Vec<u8>":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a><<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>, A></code></h3><pre><code><div class=\"where\">impl<A> <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a><<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>, A><div class=\"where\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/alloc/trait.Allocator.html\" title=\"trait core::alloc::Allocator\">Allocator</a>,</div></div>"}</script></section></div></main></body></html> |