Add builder style for list_objects

Cargo.toml

@@ -12,6 +12,7 @@ categories = ["api-bindings", "web-programming::http-client"]
 
 [dependencies]
 async-recursion = "1.0.4"
+async-trait = "0.1.73"
 base64 = "0.21.3"
 byteorder = "1.4.3"
 bytes = "1.4.0"

src/s3/args.rs

@@ -986,271 +986,6 @@ impl<'a> RemoveObjectsArgs<'a> {
     }
 }
 
-/// Argument for [list_objects_v1()](crate::s3::client::Client::list_objects_v1) S3 API
-#[derive(Clone, Debug)]
-pub struct ListObjectsV1Args {
-    pub extra_headers: Option<Multimap>,
-    pub extra_query_params: Option<Multimap>,
-    pub region: Option<String>,
-    pub bucket: String,
-    pub delimiter: Option<String>,
-    pub use_url_encoding_type: bool,
-    pub max_keys: Option<u16>,
-    pub prefix: Option<String>,
-    pub marker: Option<String>,
-}
-
-// Helper function delimiter based on recursive flag when delimiter is not
-// provided.
-fn delim_helper(delim: Option<String>, recursive: bool) -> Option<String> {
-    if delim.is_some() {
-        return delim;
-    }
-    match recursive {
-        true => None,
-        false => Some(String::from("/")),
-    }
-}
-
-impl From<ListObjectsArgs> for ListObjectsV1Args {
-    fn from(value: ListObjectsArgs) -> Self {
-        ListObjectsV1Args {
-            extra_headers: value.extra_headers,
-            extra_query_params: value.extra_query_params,
-            region: value.region,
-            bucket: value.bucket,
-            delimiter: delim_helper(value.delimiter, value.recursive),
-            use_url_encoding_type: value.use_url_encoding_type,
-            max_keys: value.max_keys,
-            prefix: value.prefix,
-            marker: value.marker,
-        }
-    }
-}
-
-impl ListObjectsV1Args {
-    /// Returns argument for [list_objects_v1()](crate::s3::client::Client::list_objects_v1) S3 API with given bucket name
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// use minio::s3::args::*;
-    /// let args = ListObjectsV1Args::new("my-bucket").unwrap();
-    /// ```
-    pub fn new(bucket_name: &str) -> Result<ListObjectsV1Args, Error> {
-        check_bucket_name(bucket_name, true)?;
-
-        Ok(ListObjectsV1Args {
-            extra_headers: None,
-            extra_query_params: None,
-            region: None,
-            bucket: bucket_name.to_owned(),
-            delimiter: None,
-            use_url_encoding_type: true,
-            max_keys: None,
-            prefix: None,
-            marker: None,
-        })
-    }
-}
-
-/// Argument for [list_objects_v2()](crate::s3::client::Client::list_objects_v2) S3 API
-#[derive(Clone, Debug)]
-pub struct ListObjectsV2Args {
-    pub extra_headers: Option<Multimap>,
-    pub extra_query_params: Option<Multimap>,
-    pub region: Option<String>,
-    pub bucket: String,
-    pub delimiter: Option<String>,
-    pub use_url_encoding_type: bool,
-    pub max_keys: Option<u16>,
-    pub prefix: Option<String>,
-    pub start_after: Option<String>,
-    pub continuation_token: Option<String>,
-    pub fetch_owner: bool,
-    pub include_user_metadata: bool,
-}
-
-impl From<ListObjectsArgs> for ListObjectsV2Args {
-    fn from(value: ListObjectsArgs) -> Self {
-        ListObjectsV2Args {
-            extra_headers: value.extra_headers,
-            extra_query_params: value.extra_query_params,
-            region: value.region,
-            bucket: value.bucket,
-            delimiter: delim_helper(value.delimiter, value.recursive),
-            use_url_encoding_type: value.use_url_encoding_type,
-            max_keys: value.max_keys,
-            prefix: value.prefix,
-            start_after: value.start_after,
-            continuation_token: value.continuation_token,
-            fetch_owner: value.fetch_owner,
-            include_user_metadata: value.include_user_metadata,
-        }
-    }
-}
-
-impl ListObjectsV2Args {
-    /// Returns argument for [list_objects_v2()](crate::s3::client::Client::list_objects_v2) S3 API with given bucket name
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// use minio::s3::args::*;
-    /// let args = ListObjectsV2Args::new("my-bucket").unwrap();
-    /// ```
-    pub fn new(bucket_name: &str) -> Result<ListObjectsV2Args, Error> {
-        check_bucket_name(bucket_name, true)?;
-        Ok(ListObjectsV2Args {
-            extra_headers: None,
-            extra_query_params: None,
-            region: None,
-            bucket: bucket_name.to_owned(),
-            delimiter: None,
-            use_url_encoding_type: true,
-            max_keys: None,
-            prefix: None,
-            start_after: None,
-            continuation_token: None,
-            fetch_owner: false,
-            include_user_metadata: false,
-        })
-    }
-}
-
-/// Argument for [list_object_versions()](crate::s3::client::Client::list_object_versions) S3 API
-pub struct ListObjectVersionsArgs {
-    pub extra_headers: Option<Multimap>,
-    pub extra_query_params: Option<Multimap>,
-    pub region: Option<String>,
-    pub bucket: String,
-    pub delimiter: Option<String>,
-    pub use_url_encoding_type: bool,
-    pub max_keys: Option<u16>,
-    pub prefix: Option<String>,
-    pub key_marker: Option<String>,
-    pub version_id_marker: Option<String>,
-}
-
-impl From<ListObjectsArgs> for ListObjectVersionsArgs {
-    fn from(value: ListObjectsArgs) -> Self {
-        ListObjectVersionsArgs {
-            extra_headers: value.extra_headers,
-            extra_query_params: value.extra_query_params,
-            region: value.region,
-            bucket: value.bucket,
-            delimiter: delim_helper(value.delimiter, value.recursive),
-            use_url_encoding_type: value.use_url_encoding_type,
-            max_keys: value.max_keys,
-            prefix: value.prefix,
-            key_marker: value.key_marker,
-            version_id_marker: value.version_id_marker,
-        }
-    }
-}
-
-impl ListObjectVersionsArgs {
-    /// Returns argument for [list_object_versions()](crate::s3::client::Client::list_object_versions) S3 API with given bucket name
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// use minio::s3::args::*;
-    /// let args = ListObjectVersionsArgs::new("my-bucket").unwrap();
-    /// ```
-    pub fn new(bucket_name: &str) -> Result<ListObjectVersionsArgs, Error> {
-        check_bucket_name(bucket_name, true)?;
-
-        Ok(ListObjectVersionsArgs {
-            extra_headers: None,
-            extra_query_params: None,
-            region: None,
-            bucket: bucket_name.to_owned(),
-            delimiter: None,
-            use_url_encoding_type: true,
-            max_keys: None,
-            prefix: None,
-            key_marker: None,
-            version_id_marker: None,
-        })
-    }
-}
-
-/// Argument for [list_objects()](crate::s3::client::Client::list_objects) API
-#[derive(Clone, Debug)]
-pub struct ListObjectsArgs {
-    pub extra_headers: Option<Multimap>,
-    pub extra_query_params: Option<Multimap>,
-    pub region: Option<String>,
-    /// Specifies the bucket name on which listing is to be performed.
-    pub bucket: String,
-    /// Delimiter to roll up common prefixes on.
-    pub delimiter: Option<String>,
-    pub use_url_encoding_type: bool,
-    pub max_keys: Option<u16>,
-    pub prefix: Option<String>,
-
-    /// Used only with ListObjectsV1.
-    pub marker: Option<String>,
-
-    /// Used only with ListObjectsV2
-    pub start_after: Option<String>,
-    /// Used only with ListObjectsV2.
-    pub continuation_token: Option<String>,
-    /// Used only with ListObjectsV2.
-    pub fetch_owner: bool,
-    /// MinIO extension for ListObjectsV2.
-    pub include_user_metadata: bool,
-
-    /// Used only with GetObjectVersions.
-    pub key_marker: Option<String>,
-    /// Used only with GetObjectVersions.
-    pub version_id_marker: Option<String>,
-
-    /// This parameter takes effect only when delimiter is None. Enables
-    /// recursive traversal for listing of the bucket and prefix.
-    pub recursive: bool,
-    /// Set this to use ListObjectsV1. Defaults to false.
-    pub use_api_v1: bool,
-    /// Set this to include versions.
-    pub include_versions: bool,
-}
-
-impl ListObjectsArgs {
-    /// Returns argument for [list_objects()](crate::s3::client::Client::list_objects) API with given bucket name and callback function for results.
-    ///
-    /// # Examples
-    ///
-    /// ```
-    /// use minio::s3::args::*;
-    /// let args = ListObjectsArgs::new("my-bucket").unwrap();
-    /// ```
-    pub fn new(bucket_name: &str) -> Result<ListObjectsArgs, Error> {
-        check_bucket_name(bucket_name, true)?;
-
-        Ok(ListObjectsArgs {
-            extra_headers: None,
-            extra_query_params: None,
-            region: None,
-            bucket: bucket_name.to_owned(),
-            delimiter: None,
-            use_url_encoding_type: true,
-            marker: None,
-            start_after: None,
-            key_marker: None,
-            max_keys: None,
-            prefix: None,
-            continuation_token: None,
-            fetch_owner: false,
-            version_id_marker: None,
-            include_user_metadata: false,
-            recursive: false,
-            use_api_v1: false,
-            include_versions: false,
-        })
-    }
-}
-
 /// Argument for [select_object_content()](crate::s3::client::Client::select_object_content) API
 pub struct SelectObjectContentArgs<'a> {
     pub extra_headers: Option<&'a Multimap>,

src/s3/builders.rs

@@ -0,0 +1,17 @@
+// 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.
+
+//! Argument builders for [minio::s3::client::Client](crate::s3::client::Client) APIs
+
+mod list_objects;
+
+pub use list_objects::*;