This is an automated email from the ASF dual-hosted git repository. xuanwo pushed a commit to branch exact-buf-write in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
commit 74562fb8b9508da5e3f57339d9a508bfd294d90b Author: Xuanwo <[email protected]> AuthorDate: Wed Aug 23 16:32:07 2023 +0800 Update comments Signed-off-by: Xuanwo <[email protected]> --- core/src/raw/oio/write/at_least_buf_write.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/core/src/raw/oio/write/at_least_buf_write.rs b/core/src/raw/oio/write/at_least_buf_write.rs index d484127d7..0add20fd9 100644 --- a/core/src/raw/oio/write/at_least_buf_write.rs +++ b/core/src/raw/oio/write/at_least_buf_write.rs @@ -21,9 +21,13 @@ use crate::*; use async_trait::async_trait; use bytes::Bytes; -/// AtLeastBufWrite is used to implement [`Write`] based on at least buffer. +/// AtLeastBufWriter is used to implement [`oio::Write`] based on at least buffer strategy: flush +/// the underlying storage when the buffered size is larger. /// -/// Users can wrap a writer and a buffer together. +/// AtLeastBufWriter makes sure that the size of the data written to the underlying storage is at +/// least `buffer_size` bytes. It's useful when the underlying storage has a minimum size limit. +/// +/// For example, S3 requires at least 5MiB for multipart uploads. pub struct AtLeastBufWriter<W: oio::Write> { inner: W,
