minio 0.2.0-alpha

MinIO SDK for Amazon S3 compatible object storage access
Documentation
// 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.

// ! S3 APIs for appending objects.

use super::Client;
use crate::s3::builders::ObjectContent;
use crate::s3::builders::{AppendObject, AppendObjectContent};
use crate::s3::segmented_bytes::SegmentedBytes;

impl Client {
    /// Creates a [`AppendObject`] request builder to append data to the end of an (existing) object.
    /// This is a lower-level API that performs a non-multipart object upload.
    ///
    /// To execute the request, call [`AppendObject::send()`](crate::s3::types::S3Api::send),
    /// which returns a [`Result`] containing a [`AppendObjectResponse`](crate::s3::response::AppendObjectResponse).    
    ///
    /// 🛈 This operation is not supported for regular non-express buckets.
    ///
    /// # Example
    ///
    /// ```no_run
    /// use minio::s3::Client;
    /// use minio::s3::response::{AppendObjectResponse, PutObjectResponse};
    /// use minio::s3::segmented_bytes::SegmentedBytes;
    /// use minio::s3::types::S3Api;
    ///
    /// #[tokio::main]
    /// async fn main() {    
    ///     let client: Client = Default::default(); // configure your client here
    ///     let data1: SegmentedBytes = SegmentedBytes::from("aaaa".to_string());
    ///     let data2: SegmentedBytes = SegmentedBytes::from("bbbb".to_string());
    ///     let resp: PutObjectResponse = client
    ///         .put_object("bucket-name", "object-name", data1)
    ///         .send().await.unwrap();
    ///     let offset_bytes = 4; // the offset at which to append the data
    ///     let resp: AppendObjectResponse = client
    ///         .append_object("bucket-name", "object-name", data2, offset_bytes)
    ///         .send().await.unwrap();
    ///     println!("size of the final object is {} bytes", resp.object_size);
    /// }
    /// ```
    pub fn append_object<S: Into<String>>(
        &self,
        bucket: S,
        object: S,
        data: SegmentedBytes,
        offset_bytes: u64,
    ) -> AppendObject {
        AppendObject::new(
            self.clone(),
            bucket.into(),
            object.into(),
            data,
            offset_bytes,
        )
    }

    /// Creates an [`AppendObjectContent`] request builder to append data to the end of an (existing)
    /// object. The content is streamed and appended to MinIO/S3. This is a higher-level API that
    /// handles multipart appends transparently.
    ///
    /// To execute the request, call [`AppendObjectContent::send()`](crate::s3::types::S3Api::send),
    /// which returns a [`Result`] containing a [`AppendObjectResponse`](crate::s3::response::AppendObjectResponse).    
    ///
    /// 🛈 This operation is not supported for regular non-express buckets.
    ///
    /// # Example
    ///
    /// ```no_run
    /// use minio::s3::Client;
    /// use minio::s3::response::{AppendObjectResponse, PutObjectResponse};
    /// use minio::s3::builders::ObjectContent;
    /// use minio::s3::segmented_bytes::SegmentedBytes;
    /// use minio::s3::types::S3Api;
    ///
    /// #[tokio::main]
    /// async fn main() {    
    /// let client: Client = Default::default(); // configure your client here
    ///     let data1: SegmentedBytes = SegmentedBytes::from("aaaa".to_string());
    ///     let content2: String = "bbbb".to_string();
    ///     let resp: PutObjectResponse = client
    ///         .put_object("bucket-name", "object-name", data1)
    ///         .send().await.unwrap();
    ///     let resp: AppendObjectResponse = client
    ///         .append_object_content("bucket-name", "object-name", content2)
    ///         .send().await.unwrap();
    ///     println!("size of the final object is {} bytes", resp.object_size);
    /// }
    /// ```
    pub fn append_object_content<S: Into<String>, C: Into<ObjectContent>>(
        &self,
        bucket: S,
        object: S,
        content: C,
    ) -> AppendObjectContent {
        AppendObjectContent::new(self.clone(), bucket.into(), object.into(), content)
    }
}