You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by xu...@apache.org on 2023/07/24 06:14:06 UTC
[incubator-opendal] 05/09: Renaming
This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch oio-reorg
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
commit f239b1609d0371dcb62ca9e526540a7e14f8e2df
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Mon Jul 24 12:53:05 2023 +0800
Renaming
Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
core/src/layers/complete.rs | 14 ++++++------
core/src/raw/oio/mod.rs | 6 +++---
..._by_range.rs => into_seekable_read_by_range.rs} | 25 +++++++++++++++-------
core/src/raw/oio/read/into_streamable_read.rs | 6 +++---
core/src/raw/oio/read/mod.rs | 8 +++----
core/src/types/reader.rs | 2 +-
6 files changed, 35 insertions(+), 26 deletions(-)
diff --git a/core/src/layers/complete.rs b/core/src/layers/complete.rs
index a820b5ab2..fdd8f2727 100644
--- a/core/src/layers/complete.rs
+++ b/core/src/layers/complete.rs
@@ -27,7 +27,7 @@ use bytes::Bytes;
use crate::raw::oio::to_flat_pager;
use crate::raw::oio::to_hierarchy_pager;
-use crate::raw::oio::ByRangeReader;
+use crate::raw::oio::ByRangeSeekableReader;
use crate::raw::oio::Entry;
use crate::raw::oio::StreamableReader;
use crate::raw::oio::ToFlatPager;
@@ -172,7 +172,7 @@ impl<A: Accessor> CompleteReaderAccessor<A> {
match (seekable, streamable) {
(true, true) => Ok((rp, CompleteReader::AlreadyComplete(r))),
(true, false) => {
- let r = oio::into_streamable_reader(r, 256 * 1024);
+ let r = oio::into_streamable_read(r, 256 * 1024);
Ok((rp, CompleteReader::NeedStreamable(r)))
}
_ => {
@@ -193,12 +193,12 @@ impl<A: Accessor> CompleteReaderAccessor<A> {
(offset, size)
}
};
- let r = oio::into_read_by_range(self.inner.clone(), path, r, offset, size);
+ let r = oio::into_seekable_read_by_range(self.inner.clone(), path, r, offset, size);
if streamable {
Ok((rp, CompleteReader::NeedSeekable(r)))
} else {
- let r = oio::into_streamable_reader(r, 256 * 1024);
+ let r = oio::into_streamable_read(r, 256 * 1024);
Ok((rp, CompleteReader::NeedBoth(r)))
}
}
@@ -223,7 +223,7 @@ impl<A: Accessor> CompleteReaderAccessor<A> {
match (seekable, streamable) {
(true, true) => Ok((rp, CompleteReader::AlreadyComplete(r))),
(true, false) => {
- let r = oio::into_streamable_reader(r, 256 * 1024);
+ let r = oio::into_streamable_read(r, 256 * 1024);
Ok((rp, CompleteReader::NeedStreamable(r)))
}
(false, _) => Err(Error::new(
@@ -532,9 +532,9 @@ impl<A: Accessor> LayeredAccessor for CompleteReaderAccessor<A> {
pub enum CompleteReader<A: Accessor, R> {
AlreadyComplete(R),
- NeedSeekable(ByRangeReader<A>),
+ NeedSeekable(ByRangeSeekableReader<A>),
NeedStreamable(StreamableReader<R>),
- NeedBoth(StreamableReader<ByRangeReader<A>>),
+ NeedBoth(StreamableReader<ByRangeSeekableReader<A>>),
}
impl<A, R> oio::Read for CompleteReader<A, R>
diff --git a/core/src/raw/oio/mod.rs b/core/src/raw/oio/mod.rs
index 65695adf5..cf7940ee1 100644
--- a/core/src/raw/oio/mod.rs
+++ b/core/src/raw/oio/mod.rs
@@ -23,12 +23,12 @@
//! our `output` traits.
mod read;
-pub use read::into_read_by_range;
pub use read::into_read_from_file;
-pub use read::into_streamable_reader;
+pub use read::into_seekable_read_by_range;
+pub use read::into_streamable_read;
pub use read::BlockingRead;
pub use read::BlockingReader;
-pub use read::ByRangeReader;
+pub use read::ByRangeSeekableReader;
pub use read::FromFileReader;
pub use read::Read;
pub use read::ReadExt;
diff --git a/core/src/raw/oio/read/into_read_by_range.rs b/core/src/raw/oio/read/into_seekable_read_by_range.rs
similarity index 95%
rename from core/src/raw/oio/read/into_read_by_range.rs
rename to core/src/raw/oio/read/into_seekable_read_by_range.rs
index ada195eb9..3e76f9b58 100644
--- a/core/src/raw/oio/read/into_read_by_range.rs
+++ b/core/src/raw/oio/read/into_seekable_read_by_range.rs
@@ -32,18 +32,26 @@ use crate::*;
/// Convert given reader into [`oio::Reader`] by range.
///
+/// # Input
+///
+/// The input is an Accessor will may return a non-seekable reader.
+///
+/// # Output
+///
+/// The output is a reader that can be seeked by range.
+///
/// # Notes
///
/// This operation is not zero cost. If the accessor already returns a
/// seekable reader, please don't use this.
-pub fn into_read_by_range<A: Accessor>(
+pub fn into_seekable_read_by_range<A: Accessor>(
acc: Arc<A>,
path: &str,
reader: A::Reader,
offset: u64,
size: u64,
-) -> ByRangeReader<A> {
- ByRangeReader {
+) -> ByRangeSeekableReader<A> {
+ ByRangeSeekableReader {
acc,
path: path.to_string(),
offset,
@@ -56,7 +64,7 @@ pub fn into_read_by_range<A: Accessor>(
}
/// ByRangeReader that can do seek on non-seekable reader.
-pub struct ByRangeReader<A: Accessor> {
+pub struct ByRangeSeekableReader<A: Accessor> {
acc: Arc<A>,
path: String,
@@ -84,7 +92,7 @@ enum State<R: oio::Read> {
/// Safety: State will only be accessed under &mut.
unsafe impl<R: oio::Read> Sync for State<R> {}
-impl<A: Accessor> ByRangeReader<A> {
+impl<A: Accessor> ByRangeSeekableReader<A> {
fn read_future(&self) -> BoxFuture<'static, Result<(RpRead, A::Reader)>> {
let acc = self.acc.clone();
let path = self.path.clone();
@@ -123,7 +131,7 @@ impl<A: Accessor> ByRangeReader<A> {
}
}
-impl<A: Accessor> oio::Read for ByRangeReader<A> {
+impl<A: Accessor> oio::Read for ByRangeSeekableReader<A> {
fn poll_read(&mut self, cx: &mut Context<'_>, buf: &mut [u8]) -> Poll<Result<usize>> {
match &mut self.state {
State::Idle => {
@@ -387,7 +395,8 @@ mod tests {
let r = MockReader {
inner: futures::io::Cursor::new(bs.to_vec()),
};
- let mut r = Box::new(into_read_by_range(acc, "x", r, 0, bs.len() as u64)) as oio::Reader;
+ let mut r =
+ Box::new(into_seekable_read_by_range(acc, "x", r, 0, bs.len() as u64)) as oio::Reader;
let mut buf = Vec::new();
r.read_to_end(&mut buf).await?;
@@ -421,7 +430,7 @@ mod tests {
let r = MockReader {
inner: futures::io::Cursor::new(bs[4096..4096 + 4096].to_vec()),
};
- let mut r = Box::new(into_read_by_range(acc, "x", r, 4096, 4096)) as oio::Reader;
+ let mut r = Box::new(into_seekable_read_by_range(acc, "x", r, 4096, 4096)) as oio::Reader;
let mut buf = Vec::new();
r.read_to_end(&mut buf).await?;
diff --git a/core/src/raw/oio/read/into_streamable_read.rs b/core/src/raw/oio/read/into_streamable_read.rs
index 0f659ff08..c3f90e24d 100644
--- a/core/src/raw/oio/read/into_streamable_read.rs
+++ b/core/src/raw/oio/read/into_streamable_read.rs
@@ -27,7 +27,7 @@ use crate::raw::*;
use crate::*;
/// into_streamable is used to make [`oio::Read`] or [`oio::BlockingRead`] streamable.
-pub fn into_streamable_reader<R>(r: R, capacity: usize) -> StreamableReader<R> {
+pub fn into_streamable_read<R>(r: R, capacity: usize) -> StreamableReader<R> {
StreamableReader {
r,
cap: capacity,
@@ -113,7 +113,7 @@ mod tests {
let cap = rng.gen_range(1..1024 * 1024);
let r = oio::Cursor::from(content.clone());
- let mut s = into_streamable_reader(Box::new(r) as oio::Reader, cap);
+ let mut s = into_streamable_read(Box::new(r) as oio::Reader, cap);
let mut bs = BytesMut::new();
while let Some(b) = s.next().await {
@@ -136,7 +136,7 @@ mod tests {
let cap = rng.gen_range(1..1024 * 1024);
let r = oio::Cursor::from(content.clone());
- let mut s = into_streamable_reader(Box::new(r) as oio::BlockingReader, cap);
+ let mut s = into_streamable_read(Box::new(r) as oio::BlockingReader, cap);
let mut bs = BytesMut::new();
while let Some(b) = s.next() {
diff --git a/core/src/raw/oio/read/mod.rs b/core/src/raw/oio/read/mod.rs
index 0ceaa5baa..06a7538ed 100644
--- a/core/src/raw/oio/read/mod.rs
+++ b/core/src/raw/oio/read/mod.rs
@@ -19,12 +19,12 @@ mod api;
pub use api::*;
mod into_streamable_read;
-pub use into_streamable_read::into_streamable_reader;
+pub use into_streamable_read::into_streamable_read;
pub use into_streamable_read::StreamableReader;
-mod into_read_by_range;
-pub use into_read_by_range::into_read_by_range;
-pub use into_read_by_range::ByRangeReader;
+mod into_seekable_read_by_range;
+pub use into_seekable_read_by_range::into_seekable_read_by_range;
+pub use into_seekable_read_by_range::ByRangeSeekableReader;
mod into_read_from_file;
pub use into_read_from_file::into_read_from_file;
diff --git a/core/src/types/reader.rs b/core/src/types/reader.rs
index 0f3bd2eaa..4b3284182 100644
--- a/core/src/types/reader.rs
+++ b/core/src/types/reader.rs
@@ -208,7 +208,7 @@ impl BlockingReader {
r
} else {
// Make this capacity configurable.
- Box::new(oio::into_streamable_reader(r, 256 * 1024))
+ Box::new(oio::into_streamable_read(r, 256 * 1024))
};
Ok(BlockingReader { inner: r })