| <!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="BlockWrite is used to implement `oio::Write` based on block uploads. By implementing BlockWrite, services don’t need to care about the details of uploading blocks."><title>BlockWrite in opendal::raw::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" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-916cea96.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="opendal" data-themes="" data-resource-suffix="" data-rustdoc-version="1.87.0-nightly (43a2e9d2c 2025-03-17)" data-channel="nightly" data-search-js="search-e7298875.js" data-settings-js="settings-d72f25bb.js"><script src="../../../static.files/storage-d8ac8691.js"></script><script defer="" src="sidebar-items.js"></script><script defer="" src="../../../static.files/main-fb8c74a8.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../../opendal/index.html"><img src="/img/external/71c0d8847d34b7f8ce3fd204c652c6f9.svg" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../opendal/index.html"><img src="/img/external/71c0d8847d34b7f8ce3fd204c652c6f9.svg" alt="logo"></a><h2><a href="../../../opendal/index.html">opendal</a><span class="version">0.53.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Block<wbr>Write</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#architecture" title="Architecture">Architecture</a></li><li><a href="#notes" title="Notes">Notes</a></li><li><a href="#requirements" title="Requirements">Requirements</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.abort_block" title="abort_block">abort_block</a></li><li><a href="#tymethod.complete_block" title="complete_block">complete_block</a></li><li><a href="#tymethod.write_block" title="write_block">write_block</a></li><li><a href="#tymethod.write_once" title="write_once">write_once</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 opendal::<wbr>raw::<wbr>oio</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">opendal</a>::<wbr><a href="../index.html">raw</a>::<wbr><a href="index.html">oio</a></div><h1>Trait <span class="trait">BlockWrite</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/opendal/raw/oio/write/block_write.rs.html#60-94">Source</a> </span></div><pre class="rust item-decl"><code>pub trait BlockWrite: |
| <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> |
| + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> |
| + 'static { |
| // Required methods |
| fn <a href="#tymethod.write_once" class="fn">write_once</a>( |
| &self, |
| size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, |
| body: <a class="struct" href="../../struct.Buffer.html" title="struct opendal::Buffer">Buffer</a>, |
| ) -> 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="type" href="../../type.Result.html" title="type opendal::Result">Result</a><<a class="struct" href="../../struct.Metadata.html" title="struct opendal::Metadata">Metadata</a>>> + <a class="trait" href="../trait.MaybeSend.html" title="trait opendal::raw::MaybeSend">MaybeSend</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_block" class="fn">write_block</a>( |
| &self, |
| block_id: <a class="struct" href="https://docs.rs/uuid/1.16.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>, |
| size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, |
| body: <a class="struct" href="../../struct.Buffer.html" title="struct opendal::Buffer">Buffer</a>, |
| ) -> 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="type" href="../../type.Result.html" title="type opendal::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="../trait.MaybeSend.html" title="trait opendal::raw::MaybeSend">MaybeSend</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.complete_block" class="fn">complete_block</a>( |
| &self, |
| block_ids: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://docs.rs/uuid/1.16.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>>, |
| ) -> 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="type" href="../../type.Result.html" title="type opendal::Result">Result</a><<a class="struct" href="../../struct.Metadata.html" title="struct opendal::Metadata">Metadata</a>>> + <a class="trait" href="../trait.MaybeSend.html" title="trait opendal::raw::MaybeSend">MaybeSend</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.abort_block" class="fn">abort_block</a>( |
| &self, |
| block_ids: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://docs.rs/uuid/1.16.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>>, |
| ) -> 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="type" href="../../type.Result.html" title="type opendal::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="../trait.MaybeSend.html" title="trait opendal::raw::MaybeSend">MaybeSend</a>; |
| }</code></pre><details class="toggle top-doc" open=""><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>BlockWrite is used to implement <a href="trait.Write.html" title="trait opendal::raw::oio::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.</p> |
| <h2 id="architecture"><a class="doc-anchor" href="#architecture">§</a>Architecture</h2> |
| <p>The architecture after adopting <a href="trait.BlockWrite.html" title="trait opendal::raw::oio::BlockWrite"><code>BlockWrite</code></a>:</p> |
| <ul> |
| <li>Services impl <code>BlockWrite</code></li> |
| <li><code>BlockWriter</code> impl <code>Write</code></li> |
| <li>Expose <code>BlockWriter</code> as <code>Accessor::Writer</code></li> |
| </ul> |
| <h2 id="notes"><a class="doc-anchor" href="#notes">§</a>Notes</h2> |
| <p><code>BlockWrite</code> has an oneshot optimization when <code>write</code> has been called only once:</p> |
| <div class="example-wrap"><pre class="language-no_build"><code>w.write(bs).await?; |
| w.close().await?;</code></pre></div> |
| <p>We will use <code>write_once</code> instead of starting a new block upload.</p> |
| <h2 id="requirements"><a class="doc-anchor" href="#requirements">§</a>Requirements</h2> |
| <p>Services that implement <code>BlockWrite</code> must fulfill the following requirements:</p> |
| <ul> |
| <li>Must be a http service that could accept <code>AsyncBody</code>.</li> |
| <li>Don’t need initialization before writing.</li> |
| <li>Block ID is generated by caller <code>BlockWrite</code> instead of services.</li> |
| <li>Complete block by an ordered block id list.</li> |
| </ul> |
| </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.write_once" class="method"><a class="src rightside" href="../../../src/opendal/raw/oio/write/block_write.rs.html#66-70">Source</a><h4 class="code-header">fn <a href="#tymethod.write_once" class="fn">write_once</a>( |
| &self, |
| size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, |
| body: <a class="struct" href="../../struct.Buffer.html" title="struct opendal::Buffer">Buffer</a>, |
| ) -> 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="type" href="../../type.Result.html" title="type opendal::Result">Result</a><<a class="struct" href="../../struct.Metadata.html" title="struct opendal::Metadata">Metadata</a>>> + <a class="trait" href="../trait.MaybeSend.html" title="trait opendal::raw::MaybeSend">MaybeSend</a></h4></section></summary><div class="docblock"><p>write_once is used to write the data to underlying storage at once.</p> |
| <p>BlockWriter will call this API when:</p> |
| <ul> |
| <li>All the data has been written to the buffer and we can perform the upload at once.</li> |
| </ul> |
| </div></details><details class="toggle method-toggle" open=""><summary><section id="tymethod.write_block" class="method"><a class="src rightside" href="../../../src/opendal/raw/oio/write/block_write.rs.html#78-83">Source</a><h4 class="code-header">fn <a href="#tymethod.write_block" class="fn">write_block</a>( |
| &self, |
| block_id: <a class="struct" href="https://docs.rs/uuid/1.16.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>, |
| size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, |
| body: <a class="struct" href="../../struct.Buffer.html" title="struct opendal::Buffer">Buffer</a>, |
| ) -> 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="type" href="../../type.Result.html" title="type opendal::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="../trait.MaybeSend.html" title="trait opendal::raw::MaybeSend">MaybeSend</a></h4></section></summary><div class="docblock"><p>write_block will write a block of the data.</p> |
| <p>BlockWriter will call this API and stores the result in |
| order.</p> |
| <ul> |
| <li>block_id is the id of the block.</li> |
| </ul> |
| </div></details><details class="toggle method-toggle" open=""><summary><section id="tymethod.complete_block" class="method"><a class="src rightside" href="../../../src/opendal/raw/oio/write/block_write.rs.html#87-90">Source</a><h4 class="code-header">fn <a href="#tymethod.complete_block" class="fn">complete_block</a>( |
| &self, |
| block_ids: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://docs.rs/uuid/1.16.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>>, |
| ) -> 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="type" href="../../type.Result.html" title="type opendal::Result">Result</a><<a class="struct" href="../../struct.Metadata.html" title="struct opendal::Metadata">Metadata</a>>> + <a class="trait" href="../trait.MaybeSend.html" title="trait opendal::raw::MaybeSend">MaybeSend</a></h4></section></summary><div class="docblock"><p>complete_block will complete the block upload to build the final |
| file.</p> |
| </div></details><details class="toggle method-toggle" open=""><summary><section id="tymethod.abort_block" class="method"><a class="src rightside" href="../../../src/opendal/raw/oio/write/block_write.rs.html#93">Source</a><h4 class="code-header">fn <a href="#tymethod.abort_block" class="fn">abort_block</a>( |
| &self, |
| block_ids: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://docs.rs/uuid/1.16.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>>, |
| ) -> 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="type" href="../../type.Result.html" title="type opendal::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="../trait.MaybeSend.html" title="trait opendal::raw::MaybeSend">MaybeSend</a></h4></section></summary><div class="docblock"><p>abort_block will cancel the block upload and purge all data.</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="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../trait.impl/opendal/raw/oio/write/block_write/trait.BlockWrite.js" async=""></script></section></div></main></body></html> |
