refactor(ops): Promote ops as a parent mod (#553)

Signed-off-by: Xuanwo <github@xuanwo.io>

Signed-off-by: Xuanwo <github@xuanwo.io>

src/ops/mod.rs

@@ -0,0 +1,44 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Operations and help utils used by [`Accessor`][crate::Accessor].
+//!
+//! # Notes
+//!
+//! Users should not use struct or functions here except the following cases:
+//!
+//! - Implement a new service support.
+//! - Implement a new Layer.
+
+mod operation;
+pub use operation::Operation;
+
+mod op_create;
+pub use op_create::OpCreate;
+mod op_delete;
+pub use op_delete::OpDelete;
+mod op_list;
+pub use op_list::OpList;
+mod op_presign;
+pub use op_presign::OpPresign;
+pub use op_presign::PresignedRequest;
+mod op_read;
+pub use op_read::OpRead;
+mod op_stat;
+pub use op_stat::OpStat;
+mod op_write;
+pub use op_write::OpWrite;
+
+mod bytes_range;
+pub use bytes_range::BytesRange;

src/ops/op_create.rs

@@ -0,0 +1,82 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::io::Result;
+
+use anyhow::anyhow;
+
+use crate::error::other;
+use crate::error::ObjectError;
+use crate::ObjectMode;
+
+/// Args for `create` operation.
+///
+/// The path must be normalized.
+#[derive(Debug, Clone, Default)]
+pub struct OpCreate {
+ path: String,
+ mode: ObjectMode,
+}
+
+impl OpCreate {
+ /// Create a new `OpCreate`.
+ ///
+ /// If input path is not match with object mode, an error will be returned.
+ pub fn new(path: &str, mode: ObjectMode) -> Result<Self> {
+ match mode {
+ ObjectMode::FILE => {
+ if path.ends_with('/') {
+ return Err(other(ObjectError::new(
+ "create",
+ path,
+ anyhow!("Is a directory"),
+ )));
+ }
+ Ok(Self {
+ path: path.to_string(),
+ mode,
+ })
+ }
+ ObjectMode::DIR => {
+ if !path.ends_with('/') {
+ return Err(other(ObjectError::new(
+ "create",
+ path,
+ anyhow!("Not a directory"),
+ )));
+ }
+
+ Ok(Self {
+ path: path.to_string(),
+ mode,
+ })
+ }
+ ObjectMode::Unknown => Err(other(ObjectError::new(
+ "create",
+ path,
+ anyhow!("create unknown object mode is not supported"),
+ ))),
+ }
+ }
+
+ /// Get path from option.
+ pub fn path(&self) -> &str {
+ &self.path
+ }
+
+ /// Get object mode from option.
+ pub fn mode(&self) -> ObjectMode {
+ self.mode
+ }
+}

src/ops/op_delete.rs

@@ -0,0 +1,37 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::io::Result;
+
+/// Args for `delete` operation.
+///
+/// The path must be normalized.
+#[derive(Debug, Clone, Default)]
+pub struct OpDelete {
+ path: String,
+}
+
+impl OpDelete {
+ /// Create a new `OpDelete`.
+ pub fn new(path: &str) -> Result<Self> {
+ Ok(Self {
+ path: path.to_string(),
+ })
+ }
+
+ /// Get path from option.
+ pub fn path(&self) -> &str {
+ &self.path
+ }
+}

src/ops/op_list.rs

@@ -0,0 +1,52 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::io::Result;
+
+use anyhow::anyhow;
+
+use crate::error::other;
+use crate::error::ObjectError;
+
+/// Args for `list` operation.
+///
+/// The path must be normalized.
+#[derive(Debug, Clone, Default)]
+pub struct OpList {
+ path: String,
+}
+
+impl OpList {
+ /// Create a new `OpList`.
+ ///
+ /// If input path is not a dir path, an error will be returned.
+ pub fn new(path: &str) -> Result<Self> {
+ if !path.ends_with('/') {
+ return Err(other(ObjectError::new(
+ "list",
+ path,
+ anyhow!("Not a directory"),
+ )));
+ }
+
+ Ok(Self {
+ path: path.to_string(),
+ })
+ }
+
+ /// Get path from option.
+ pub fn path(&self) -> &str {
+ &self.path
+ }
+}

src/ops/op_presign.rs

@@ -0,0 +1,89 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::io::Result;
+
+use time::Duration;
+
+use super::Operation;
+
+/// Args for `presign` operation.
+///
+/// The path must be normalized.
+#[derive(Debug, Clone, Default)]
+pub struct OpPresign {
+ path: String,
+ op: Operation,
+ expire: Duration,
+}
+
+impl OpPresign {
+ /// Create a new `OpPresign`.
+ pub fn new(path: &str, op: Operation, expire: Duration) -> Result<Self> {
+ Ok(Self {
+ path: path.to_string(),
+ op,
+ expire,
+ })
+ }
+
+ /// Get path from op.
+ pub fn path(&self) -> &str {
+ &self.path
+ }
+
+ /// Get operation from op.
+ pub fn operation(&self) -> Operation {
+ self.op
+ }
+
+ /// Get expire from op.
+ pub fn expire(&self) -> Duration {
+ self.expire
+ }
+}
+
+/// PresignedRequest is a presigned request return by `presign`.
+#[derive(Debug, Clone)]
+pub struct PresignedRequest {
+ method: http::Method,
+ uri: http::Uri,
+ headers: http::HeaderMap,
+}
+
+impl PresignedRequest {
+ /// Create a new PresignedRequest
+ pub fn new(method: http::Method, uri: http::Uri, headers: http::HeaderMap) -> Self {
+ Self {
+ method,
+ uri,
+ headers,
+ }
+ }
+
+ /// Return request's method.
+ pub fn method(&self) -> &http::Method {
+ &self.method
+ }
+
+ /// Return request's uri.
+ pub fn uri(&self) -> &http::Uri {
+ &self.uri
+ }
+
+ /// Return request's header.
+ pub fn header(&self) -> &http::HeaderMap {
+ &self.headers
+ }
+}

src/ops/op_read.rs

@@ -0,0 +1,90 @@
+// Copyright 2022 Datafuse Labs.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::io::Result;
+use std::ops::RangeBounds;
+
+use anyhow::anyhow;
+
+use super::BytesRange;
+use crate::error::other;
+use crate::error::ObjectError;
+
+/// Args for `read` operation.
+///
+/// The path must be normalized.
+#[derive(Debug, Clone, Default)]
+pub struct OpRead {
+ path: String,
+ offset: Option<u64>,
+ size: Option<u64>,
+}
+
+impl OpRead {
+ /// Create a new `OpRead`.
+ ///
+ /// If input path is not a file path, an error will be returned.
+ pub fn new(path: &str, range: impl RangeBounds<u64>) -> Result<Self> {
+ if path.ends_with('/') {
+ return Err(other(ObjectError::new(
+ "read",
+ path,
+ anyhow!("Is a directory"),
+ )));
+ }
+
+ let br = BytesRange::from(range);
+
+ Ok(Self {
+ path: path.to_string(),
+ offset: br.offset(),
+ size: br.size(),
+ })
+ }
+
+ pub(crate) fn new_with_offset(
+ path: &str,
+ offset: Option<u64>,
+ size: Option<u64>,
+ ) -> Result<Self> {
+ if path.ends_with('/') {
+ return Err(other(ObjectError::new(
+ "read",
+ path,
+ anyhow!("Is a directory"),
+ )));
+ }
+
+ Ok(Self {
+ path: path.to_string(),
+ offset,
+ size,
+ })
+ }
+
+ /// Get path from option.
+ pub fn path(&self) -> &str {
+ &self.path
+ }
+
+ /// Get offset from option.
+ pub fn offset(&self) -> Option<u64> {
+ self.offset
+ }
+
+ /// Get size from option.
+ pub fn size(&self) -> Option<u64> {
+ self.size
+ }
+}