mirror of
https://github.com/minio/minio-rs.git
synced 2025-12-06 15:26:51 +08:00
e16d6d40cf
Adopt the typed-builder crate throughout the S3 API to provide compile-time validation of builder patterns. This change improves type safety and developer experience when constructing S3 API requests.
75 lines
2.9 KiB
Rust
75 lines
2.9 KiB
Rust
// MinIO Rust Library for Amazon S3 Compatible Cloud Storage
|
|
// Copyright 2025 MinIO, Inc.
|
|
//
|
|
// 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 crate::s3::client::MinioClient;
|
|
use crate::s3::error::ValidationErr;
|
|
use crate::s3::multimap_ext::Multimap;
|
|
use crate::s3::response::PutObjectLockConfigResponse;
|
|
use crate::s3::segmented_bytes::SegmentedBytes;
|
|
use crate::s3::types::{ObjectLockConfig, S3Api, S3Request, ToS3Request};
|
|
use crate::s3::utils::{check_bucket_name, insert};
|
|
use bytes::Bytes;
|
|
use http::Method;
|
|
use std::sync::Arc;
|
|
use typed_builder::TypedBuilder;
|
|
|
|
/// Argument builder for the [`PutObjectLockConfig`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectLockConfiguration.html) S3 API operation.
|
|
///
|
|
/// This struct constructs the parameters required for the [`Client::put_object_lock_config`](crate::s3::client::MinioClient::put_object_lock_config) method.
|
|
#[derive(Clone, Debug, TypedBuilder)]
|
|
pub struct PutObjectLockConfig {
|
|
#[builder(!default)] // force required
|
|
client: MinioClient,
|
|
#[builder(default, setter(into))]
|
|
extra_headers: Option<Multimap>,
|
|
#[builder(default, setter(into))]
|
|
extra_query_params: Option<Multimap>,
|
|
#[builder(default, setter(into))]
|
|
region: Option<String>,
|
|
#[builder(setter(into))] // force required + accept Into<String>
|
|
bucket: String,
|
|
#[builder(default)]
|
|
config: ObjectLockConfig,
|
|
}
|
|
|
|
/// Builder type for [`PutObjectLockConfig`] that is returned by [`MinioClient::put_object_lock_config`](crate::s3::client::MinioClient::put_object_lock_config).
|
|
///
|
|
/// This type alias simplifies the complex generic signature generated by the `typed_builder` crate.
|
|
pub type PutObjectLockConfigBldr =
|
|
PutObjectLockConfigBuilder<((MinioClient,), (), (), (), (String,), ())>;
|
|
|
|
impl S3Api for PutObjectLockConfig {
|
|
type S3Response = PutObjectLockConfigResponse;
|
|
}
|
|
|
|
impl ToS3Request for PutObjectLockConfig {
|
|
fn to_s3request(self) -> Result<S3Request, ValidationErr> {
|
|
check_bucket_name(&self.bucket, true)?;
|
|
|
|
let bytes: Bytes = self.config.to_xml().into();
|
|
let body = Arc::new(SegmentedBytes::from(bytes));
|
|
|
|
Ok(S3Request::builder()
|
|
.client(self.client)
|
|
.method(Method::PUT)
|
|
.region(self.region)
|
|
.bucket(self.bucket)
|
|
.query_params(insert(self.extra_query_params, "object-lock"))
|
|
.headers(self.extra_headers.unwrap_or_default())
|
|
.body(body)
|
|
.build())
|
|
}
|
|
}
|