mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-15 12:30:38 +00:00
39 lines
16 KiB
HTML
39 lines
16 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="Read is the internal trait used by OpenDAL to read data from storage."><title>Read in 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-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 trait"><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="#">Read</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="#">Read</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#notes" title="Notes">Notes</a><ul><li><a href="#object-safety" title="Object Safety">Object Safety</a></li></ul></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.read" title="read">read</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.read_all" title="read_all">read_all</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Read-for-()" title="()">()</a></li><li><a href="#impl-Read-for-Box%3CT%3E" title="Box<T>">Box<T></a></li><li><a href="#impl-Read-for-Bytes" title="Bytes">Bytes</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></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>Trait <span class="trait">Read</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><pre class="rust item-decl"><code>pub trait Read:
|
||
<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>
|
||
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>
|
||
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
||
// Required method
|
||
fn <a href="#tymethod.read" class="fn">read</a>(
|
||
&mut self,
|
||
) -> impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../struct.Buffer.html" title="struct object_store::Buffer">Buffer</a>, <a class="struct" href="../../struct.Error.html" title="struct object_store::Error">Error</a>>> + MaybeSend;
|
||
|
||
// Provided method
|
||
fn <a href="#method.read_all" class="fn">read_all</a>(
|
||
&mut self,
|
||
) -> impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../struct.Buffer.html" title="struct object_store::Buffer">Buffer</a>, <a class="struct" href="../../struct.Error.html" title="struct object_store::Error">Error</a>>> + MaybeSend { ... }
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Read is the internal trait used by OpenDAL to read data from storage.</p>
|
||
<p>Users should not use or import this trait unless they are implementing an <code>Accessor</code>.</p>
|
||
<h2 id="notes"><a class="doc-anchor" href="#notes">§</a>Notes</h2><h3 id="object-safety"><a class="doc-anchor" href="#object-safety">§</a>Object Safety</h3>
|
||
<p><code>Read</code> uses <code>async in trait</code>, making it not object safe, preventing the use of <code>Box<dyn Read></code>.
|
||
To address this, we’ve introduced <a href="trait.ReadDyn.html" title="trait object_store::layers::mock::ReadDyn"><code>ReadDyn</code></a> and its compatible type <code>Box<dyn ReadDyn></code>.</p>
|
||
<p><code>ReadDyn</code> uses <code>Box::pin()</code> to transform the returned future into a [<code>BoxedFuture</code>], introducing
|
||
an additional layer of indirection and an extra allocation. Ideally, <code>ReadDyn</code> should occur only
|
||
once, at the outermost level of our API.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.read" class="method"><h4 class="code-header">fn <a href="#tymethod.read" class="fn">read</a>(&mut self) -> impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../struct.Buffer.html" title="struct object_store::Buffer">Buffer</a>, <a class="struct" href="../../struct.Error.html" title="struct object_store::Error">Error</a>>> + MaybeSend</h4></section></summary><div class="docblock"><p>Read at the given offset with the given size.</p>
|
||
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.read_all" class="method"><h4 class="code-header">fn <a href="#method.read_all" class="fn">read_all</a>(
|
||
&mut self,
|
||
) -> impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../struct.Buffer.html" title="struct object_store::Buffer">Buffer</a>, <a class="struct" href="../../struct.Error.html" title="struct object_store::Error">Error</a>>> + MaybeSend</h4></section></summary><div class="docblock"><p>Read all data from the reader.</p>
|
||
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Read-for-()" class="impl"><a href="#impl-Read-for-()" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></h3></section></summary><div class="impl-items"><section id="method.read" class="method trait-impl"><a href="#method.read" class="anchor">§</a><h4 class="code-header">async fn <a class="fn">read</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../struct.Buffer.html" title="struct object_store::Buffer">Buffer</a>, <a class="struct" href="../../struct.Error.html" title="struct object_store::Error">Error</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Read-for-Bytes" class="impl"><a href="#impl-Read-for-Bytes" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a> for Bytes</h3></section></summary><div class="impl-items"><section id="method.read-1" class="method trait-impl"><a href="#method.read-1" class="anchor">§</a><h4 class="code-header">async fn <a class="fn">read</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../struct.Buffer.html" title="struct object_store::Buffer">Buffer</a>, <a class="struct" href="../../struct.Error.html" title="struct object_store::Error">Error</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Read-for-Box%3CT%3E" class="impl"><a href="#impl-Read-for-Box%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T><div class="where">where
|
||
T: <a class="trait" href="trait.ReadDyn.html" title="trait object_store::layers::mock::ReadDyn">ReadDyn</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3><div class="docblock"><h4 id="note"><a class="doc-anchor" href="#note">§</a>NOTE</h4>
|
||
<p>Take care about the <code>deref_mut()</code> here. This makes sure that we are calling functions
|
||
upon <code>&mut T</code> instead of <code>&mut Box<T></code>. The later could result in infinite recursion.</p>
|
||
</div></section></summary><div class="impl-items"><section id="method.read-2" class="method trait-impl"><a href="#method.read-2" class="anchor">§</a><h4 class="code-header">async fn <a class="fn">read</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../struct.Buffer.html" title="struct object_store::Buffer">Buffer</a>, <a class="struct" href="../../struct.Error.html" title="struct object_store::Error">Error</a>></h4></section><section id="method.read_all-1" class="method trait-impl"><a href="#method.read_all-1" class="anchor">§</a><h4 class="code-header">async fn <a class="fn">read_all</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../struct.Buffer.html" title="struct object_store::Buffer">Buffer</a>, <a class="struct" href="../../struct.Error.html" title="struct object_store::Error">Error</a>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><section id="impl-Read-for-Buffer" class="impl"><a href="#impl-Read-for-Buffer" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a> for <a class="struct" href="../../struct.Buffer.html" title="struct object_store::Buffer">Buffer</a></h3></section><section id="impl-Read-for-MockReader" class="impl"><a class="src rightside" href="../../../src/object_store/layers/mock.rs.html#95-99">Source</a><a href="#impl-Read-for-MockReader" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a> for <a class="struct" href="struct.MockReader.html" title="struct object_store::layers::mock::MockReader">MockReader</a></h3></section><section id="impl-Read-for-HttpBody" class="impl"><a href="#impl-Read-for-HttpBody" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a> for HttpBody</h3></section><section id="impl-Read-for-TwoWays%3CONE,+TWO%3E" class="impl"><a href="#impl-Read-for-TwoWays%3CONE,+TWO%3E" class="anchor">§</a><h3 class="code-header">impl<ONE, TWO> <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a> for TwoWays<ONE, TWO><div class="where">where
|
||
ONE: <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a>,
|
||
TWO: <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a>,</div></h3></section><section id="impl-Read-for-ThreeWays%3CONE,+TWO,+THREE%3E" class="impl"><a href="#impl-Read-for-ThreeWays%3CONE,+TWO,+THREE%3E" class="anchor">§</a><h3 class="code-header">impl<ONE, TWO, THREE> <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a> for ThreeWays<ONE, TWO, THREE><div class="where">where
|
||
ONE: <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a>,
|
||
TWO: <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a>,
|
||
THREE: <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a>,</div></h3></section><section id="impl-Read-for-FourWays%3CONE,+TWO,+THREE,+FOUR%3E" class="impl"><a href="#impl-Read-for-FourWays%3CONE,+TWO,+THREE,+FOUR%3E" class="anchor">§</a><h3 class="code-header">impl<ONE, TWO, THREE, FOUR> <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a> for FourWays<ONE, TWO, THREE, FOUR><div class="where">where
|
||
ONE: <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a>,
|
||
TWO: <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a>,
|
||
THREE: <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a>,
|
||
FOUR: <a class="trait" href="trait.Read.html" title="trait object_store::layers::mock::Read">Read</a>,</div></h3></section></div><script src="../../../trait.impl/opendal_core/raw/oio/read/api/trait.Read.js" data-ignore-extern-crates="opendal_core,std,bytes,alloc" async></script></section></div></main></body></html> |