mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-30 03:40:37 +00:00
19 lines
14 KiB
HTML
19 lines
14 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="`oio` provides OpenDAL’s raw traits and types that opendal returns as output."><title>object_store::layers::mock::oio - 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="object_store" 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 oio</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</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module oio</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="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In object_<wbr>store::<wbr>layers::<wbr>mock</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>::<wbr><a href="../../index.html">layers</a>::<wbr><a href="../index.html">mock</a></div><h1>Module <span>oio</span> <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><code>oio</code> provides OpenDAL’s raw traits and types that opendal returns as
|
||
output.</p>
|
||
<p>Those types should only be used internally and we don’t want users to
|
||
depend on them.</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.AppendWriter.html" title="struct object_store::layers::mock::oio::AppendWriter">Append<wbr>Writer</a></dt><dd>AppendWriter will implements <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on append object.</dd><dt><a class="struct" href="struct.BatchDeleteResult.html" title="struct object_store::layers::mock::oio::BatchDeleteResult">Batch<wbr>Delete<wbr>Result</a></dt><dd>BatchDeleteResult is the result of batch delete operation.</dd><dt><a class="struct" href="struct.BatchDeleter.html" title="struct object_store::layers::mock::oio::BatchDeleter">Batch<wbr>Deleter</a></dt><dd>BatchDeleter is used to implement <a href="../trait.Delete.html" title="trait object_store::layers::mock::Delete"><code>oio::Delete</code></a> based on batch delete.</dd><dt><a class="struct" href="struct.BlockWriter.html" title="struct object_store::layers::mock::oio::BlockWriter">Block<wbr>Writer</a></dt><dd>BlockWriter will implement <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on block
|
||
uploads.</dd><dt><a class="struct" href="struct.Entry.html" title="struct object_store::layers::mock::oio::Entry">Entry</a></dt><dd>Entry is returned by <code>Page</code> or <code>BlockingPage</code> during list operations.</dd><dt><a class="struct" href="struct.FlatLister.html" title="struct object_store::layers::mock::oio::FlatLister">Flat<wbr>Lister</a></dt><dd>FlatLister will walk dir in bottom up way:</dd><dt><a class="struct" href="struct.FlexBuf.html" title="struct object_store::layers::mock::oio::FlexBuf">FlexBuf</a></dt><dd>FlexBuf is a buffer that support frozen bytes and reuse existing allocated memory.</dd><dt><a class="struct" href="struct.HierarchyLister.html" title="struct object_store::layers::mock::oio::HierarchyLister">Hierarchy<wbr>Lister</a></dt><dd>ToHierarchyLister will convert a flat list to hierarchy by filter
|
||
not needed entries.</dd><dt><a class="struct" href="struct.MultipartPart.html" title="struct object_store::layers::mock::oio::MultipartPart">Multipart<wbr>Part</a></dt><dd>The result of <a href="../trait.MultipartWrite.html#tymethod.write_part" title="method object_store::layers::mock::MultipartWrite::write_part"><code>MultipartWrite::write_part</code></a>.</dd><dt><a class="struct" href="struct.MultipartWriter.html" title="struct object_store::layers::mock::oio::MultipartWriter">Multipart<wbr>Writer</a></dt><dd>MultipartWriter will implement <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on multipart
|
||
uploads.</dd><dt><a class="struct" href="struct.OneShotDeleter.html" title="struct object_store::layers::mock::oio::OneShotDeleter">OneShot<wbr>Deleter</a></dt><dd>OneShotDelete is used to implement <a href="../trait.Delete.html" title="trait object_store::layers::mock::Delete"><code>oio::Delete</code></a> based on one shot.</dd><dt><a class="struct" href="struct.OneShotWriter.html" title="struct object_store::layers::mock::oio::OneShotWriter">OneShot<wbr>Writer</a></dt><dd>OneShotWrite is used to implement <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on one shot.</dd><dt><a class="struct" href="struct.PageContext.html" title="struct object_store::layers::mock::oio::PageContext">Page<wbr>Context</a></dt><dd>PageContext is the context passing between <code>PageList</code>.</dd><dt><a class="struct" href="struct.PageLister.html" title="struct object_store::layers::mock::oio::PageLister">Page<wbr>Lister</a></dt><dd>PageLister implements <a href="../trait.List.html" title="trait object_store::layers::mock::List"><code>oio::List</code></a> based on <a href="../trait.PageList.html" title="trait object_store::layers::mock::PageList"><code>PageList</code></a>.</dd><dt><a class="struct" href="struct.PooledBuf.html" title="struct object_store::layers::mock::oio::PooledBuf">Pooled<wbr>Buf</a></dt><dd>PooledBuf is a buffer pool that designed for reusing already allocated bufs.</dd><dt><a class="struct" href="struct.PositionWriter.html" title="struct object_store::layers::mock::oio::PositionWriter">Position<wbr>Writer</a></dt><dd>PositionWriter will implement <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on position write.</dd><dt><a class="struct" href="struct.PrefixLister.html" title="struct object_store::layers::mock::oio::PrefixLister">Prefix<wbr>Lister</a></dt><dd>PrefixLister is used to filter entries by prefix.</dd><dt><a class="struct" href="struct.QueueBuf.html" title="struct object_store::layers::mock::oio::QueueBuf">Queue<wbr>Buf</a></dt><dd>QueueBuf is a queue of <a href="../../../struct.Buffer.html" title="struct object_store::Buffer"><code>Buffer</code></a>.</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.AppendWrite.html" title="trait object_store::layers::mock::oio::AppendWrite">Append<wbr>Write</a></dt><dd>AppendWrite is used to implement <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on append
|
||
object. By implementing AppendWrite, services don’t need to
|
||
care about the details of buffering and uploading parts.</dd><dt><a class="trait" href="trait.BatchDelete.html" title="trait object_store::layers::mock::oio::BatchDelete">Batch<wbr>Delete</a></dt><dd>BatchDelete is used to implement <a href="../trait.Delete.html" title="trait object_store::layers::mock::Delete"><code>oio::Delete</code></a> based on batch delete operation.</dd><dt><a class="trait" href="trait.BlockWrite.html" title="trait object_store::layers::mock::oio::BlockWrite">Block<wbr>Write</a></dt><dd>BlockWrite is used to implement <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on block
|
||
uploads. By implementing BlockWrite, services don’t need to
|
||
care about the details of uploading blocks.</dd><dt><a class="trait" href="trait.Delete.html" title="trait object_store::layers::mock::oio::Delete">Delete</a></dt><dd>The Delete trait defines interfaces for performing deletion operations.</dd><dt><a class="trait" href="trait.DeleteDyn.html" title="trait object_store::layers::mock::oio::DeleteDyn">Delete<wbr>Dyn</a></dt><dd>The dyn version of <a href="../trait.Delete.html" title="trait object_store::layers::mock::Delete"><code>Delete</code></a></dd><dt><a class="trait" href="trait.List.html" title="trait object_store::layers::mock::oio::List">List</a></dt><dd>Page trait is used by [<code>raw::Accessor</code>] to implement <code>list</code> operation.</dd><dt><a class="trait" href="trait.ListDyn.html" title="trait object_store::layers::mock::oio::ListDyn">ListDyn</a></dt><dd>ListDyn is the dyn version of <a href="../trait.List.html" title="trait object_store::layers::mock::List"><code>List</code></a>. Makes it possible to use as
|
||
<code>Box<dyn ListDyn></code>.</dd><dt><a class="trait" href="trait.MultipartWrite.html" title="trait object_store::layers::mock::oio::MultipartWrite">Multipart<wbr>Write</a></dt><dd>MultipartWrite is used to implement <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on multipart
|
||
uploads. By implementing MultipartWrite, services don’t need to
|
||
care about the details of uploading parts.</dd><dt><a class="trait" href="trait.OneShotDelete.html" title="trait object_store::layers::mock::oio::OneShotDelete">OneShot<wbr>Delete</a></dt><dd>OneShotDelete is used to implement <a href="../trait.Delete.html" title="trait object_store::layers::mock::Delete"><code>oio::Delete</code></a> based on one shot operation.</dd><dt><a class="trait" href="trait.OneShotWrite.html" title="trait object_store::layers::mock::oio::OneShotWrite">OneShot<wbr>Write</a></dt><dd>OneShotWrite is used to implement <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on one shot operation.
|
||
By implementing OneShotWrite, services don’t need to care about the details.</dd><dt><a class="trait" href="trait.PageList.html" title="trait object_store::layers::mock::oio::PageList">Page<wbr>List</a></dt><dd>PageList is used to implement <a href="../trait.List.html" title="trait object_store::layers::mock::List"><code>oio::List</code></a> based on API supporting pagination. By implementing
|
||
PageList, services don’t need to care about the details of page list.</dd><dt><a class="trait" href="trait.PositionWrite.html" title="trait object_store::layers::mock::oio::PositionWrite">Position<wbr>Write</a></dt><dd>PositionWrite is used to implement <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>oio::Write</code></a> based on position write.</dd><dt><a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::oio::Read">Read</a></dt><dd>Read is the internal trait used by OpenDAL to read data from storage.</dd><dt><a class="trait" href="trait.ReadDyn.html" title="trait object_store::layers::mock::oio::ReadDyn">ReadDyn</a></dt><dd>ReadDyn is the dyn version of <a href="../trait.Read.html" title="trait object_store::layers::mock::Read"><code>Read</code></a> make it possible to use as
|
||
<code>Box<dyn ReadDyn></code>.</dd><dt><a class="trait" href="trait.Write.html" title="trait object_store::layers::mock::oio::Write">Write</a></dt><dd>Write is the trait that OpenDAL returns to callers.</dd><dt><a class="trait" href="trait.WriteDyn.html" title="trait object_store::layers::mock::oio::WriteDyn">Write<wbr>Dyn</a></dt><dd>WriteDyn is the dyn version of <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>Write</code></a> make it possible to use as
|
||
<code>Box<dyn WriteDyn></code>.</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.Deleter.html" title="type object_store::layers::mock::oio::Deleter">Deleter</a></dt><dd>Deleter is a type erased <a href="../trait.Delete.html" title="trait object_store::layers::mock::Delete"><code>Delete</code></a></dd><dt><a class="type" href="type.Lister.html" title="type object_store::layers::mock::oio::Lister">Lister</a></dt><dd>The boxed version of <a href="../trait.List.html" title="trait object_store::layers::mock::List"><code>List</code></a></dd><dt><a class="type" href="type.Reader.html" title="type object_store::layers::mock::oio::Reader">Reader</a></dt><dd>Reader is a type erased <a href="../trait.Read.html" title="trait object_store::layers::mock::Read"><code>Read</code></a>.</dd><dt><a class="type" href="type.Writer.html" title="type object_store::layers::mock::oio::Writer">Writer</a></dt><dd>Writer is a type erased <a href="../trait.Write.html" title="trait object_store::layers::mock::Write"><code>Write</code></a></dd></dl></section></div></main></body></html> |