rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-05-17 21:40:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2c331a8643edcda236a263ab5dd73ec218e2e72f
greptimedb/object_store/layers/mock/index.html
github-merge-queue[bot] 2c331a8643 Deploying to gh-pages from @ GreptimeTeam/greptimedb@0572a680af 🚀
2026-03-13 04:38:03 +00:00

15 lines
18 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 `mock` mod in crate `object_store`."><title>object_store::layers::mock - 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="../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 mock</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module mock</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="#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</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">object_store</a>::<wbr><a href="../index.html">layers</a></div><h1>Module <span>mock</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/object_store/layers/mock.rs.html#15-236">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="oio/index.html" title="mod object_store::layers::mock::oio">oio</a></dt><dd><code>oio</code> provides OpenDAL’s raw traits and types that opendal returns as
output.</dd></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.AppendWriter.html" title="struct object_store::layers::mock::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::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::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::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.Buffer.html" title="struct object_store::layers::mock::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::layers::mock::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.Error.html" title="struct object_store::layers::mock::Error">Error</a></dt><dd>Error is the error struct returned by all opendal functions.</dd><dt><a class="struct" href="struct.FlatLister.html" title="struct object_store::layers::mock::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::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::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.Metadata.html" title="struct object_store::layers::mock::Metadata">Metadata</a></dt><dd>Metadata contains all the information related to a specific path.</dd><dt><a class="struct" href="struct.MockAccessor.html" title="struct object_store::layers::mock::MockAccessor">Mock<wbr>Accessor</a></dt><dt><a class="struct" href="struct.MockDeleter.html" title="struct object_store::layers::mock::MockDeleter">Mock<wbr>Deleter</a></dt><dt><a class="struct" href="struct.MockLayer.html" title="struct object_store::layers::mock::MockLayer">Mock<wbr>Layer</a></dt><dt><a class="struct" href="struct.MockLayerBuilder.html" title="struct object_store::layers::mock::MockLayerBuilder">Mock<wbr>Layer<wbr>Builder</a></dt><dd>Builder for <a href="struct.MockLayer.html"><code>MockLayer</code></a>.</dd><dt><a class="struct" href="struct.MockLister.html" title="struct object_store::layers::mock::MockLister">Mock<wbr>Lister</a></dt><dt><a class="struct" href="struct.MockReader.html" title="struct object_store::layers::mock::MockReader">Mock<wbr>Reader</a></dt><dt><a class="struct" href="struct.MockWriter.html" title="struct object_store::layers::mock::MockWriter">Mock<wbr>Writer</a></dt><dt><a class="struct" href="struct.MultipartPart.html" title="struct object_store::layers::mock::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::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::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::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.OpDelete.html" title="struct object_store::layers::mock::OpDelete">OpDelete</a></dt><dd>Args for <code>delete</code> operation.</dd><dt><a class="struct" href="struct.OpList.html" title="struct object_store::layers::mock::OpList">OpList</a></dt><dd>Args for <code>list</code> operation.</dd><dt><a class="struct" href="struct.OpRead.html" title="struct object_store::layers::mock::OpRead">OpRead</a></dt><dd>Args for <code>read</code> operation.</dd><dt><a class="struct" href="struct.OpWrite.html" title="struct object_store::layers::mock::OpWrite">OpWrite</a></dt><dd>Args for <code>write</code> operation.</dd><dt><a class="struct" href="struct.PageContext.html" title="struct object_store::layers::mock::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::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::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::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::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::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><dt><a class="struct" href="struct.RpDelete.html" title="struct object_store::layers::mock::RpDelete">RpDelete</a></dt><dd>Reply for <code>delete</code> operation</dd><dt><a class="struct" href="struct.RpList.html" title="struct object_store::layers::mock::RpList">RpList</a></dt><dd>Reply for <code>list</code> operation.</dd><dt><a class="struct" href="struct.RpRead.html" title="struct object_store::layers::mock::RpRead">RpRead</a></dt><dd>Reply for <code>read</code> operation.</dd><dt><a class="struct" href="struct.RpWrite.html" title="struct object_store::layers::mock::RpWrite">RpWrite</a></dt><dd>Reply for <code>write</code> operation.</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.ErrorKind.html" title="enum object_store::layers::mock::ErrorKind">Error<wbr>Kind</a></dt><dd>ErrorKind is all kinds of Error of opendal.</dd><dt><a class="enum" href="enum.MockLayerBuilderError.html" title="enum object_store::layers::mock::MockLayerBuilderError">Mock<wbr>Layer<wbr>Builder<wbr>Error</a></dt><dd>Error type for MockLayerBuilder</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::layers::mock::Access">Access</a></dt><dd>Underlying trait of all backends for implementers.</dd><dt><a class="trait" href="trait.AppendWrite.html" title="trait object_store::layers::mock::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::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::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::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::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.Layer.html" title="trait object_store::layers::mock::Layer">Layer</a></dt><dd>Layer is used to intercept the operations on the underlying storage.</dd><dt><a class="trait" href="trait.LayeredAccess.html" title="trait object_store::layers::mock::LayeredAccess">Layered<wbr>Access</a></dt><dd>LayeredAccess is layered accessor that forward all not implemented
method to inner.</dd><dt><a class="trait" href="trait.List.html" title="trait object_store::layers::mock::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.MultipartWrite.html" title="trait object_store::layers::mock::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::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::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::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::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::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::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&lt;dyn ReadDyn&gt;</code>.</dd><dt><a class="trait" href="trait.Write.html" title="trait object_store::layers::mock::Write">Write</a></dt><dd>Write is the trait that OpenDAL returns to callers.</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.CopyInterceptor.html" title="type object_store::layers::mock::CopyInterceptor">Copy<wbr>Interceptor</a></dt><dt><a class="type" href="type.Deleter.html" title="type object_store::layers::mock::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::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.MockDeleterFactory.html" title="type object_store::layers::mock::MockDeleterFactory">Mock<wbr>Deleter<wbr>Factory</a></dt><dt><a class="type" href="type.MockListerFactory.html" title="type object_store::layers::mock::MockListerFactory">Mock<wbr>Lister<wbr>Factory</a></dt><dt><a class="type" href="type.MockReaderFactory.html" title="type object_store::layers::mock::MockReaderFactory">Mock<wbr>Reader<wbr>Factory</a></dt><dt><a class="type" href="type.MockWriterFactory.html" title="type object_store::layers::mock::MockWriterFactory">Mock<wbr>Writer<wbr>Factory</a></dt><dt><a class="type" href="type.Reader.html" title="type object_store::layers::mock::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.Result.html" title="type object_store::layers::mock::Result">Result</a></dt><dd>Result that is a wrapper of <code>Result&lt;T, opendal::Error&gt;</code></dd><dt><a class="type" href="type.Writer.html" title="type object_store::layers::mock::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>
Reference in New Issue View Git Blame Copy Permalink