Struct S3Backend 

pub struct S3Backend { /* private fields */ }

A storage backend using S3-compatible object storage.

This backend supports AWS S3 and any S3-compatible service like MinIO, Ceph, Cloudflare R2, Scaleway, OVH, Wasabi, and Backblaze B2.

Example

use alimentar::backend::{CredentialSource, S3Backend};

// AWS S3
let backend = S3Backend::new(
    "my-bucket",
    "us-east-1",
    None, // Use default AWS endpoint
    CredentialSource::Environment,
)
.unwrap();

// MinIO (local)
let backend = S3Backend::new(
    "datasets",
    "us-east-1",
    Some("http://localhost:9000".to_string()),
    CredentialSource::Static {
        access_key: "minioadmin".to_string(),
        secret_key: "minioadmin".to_string(),
    },
)
.unwrap();

Implementations

impl S3Backend

pub fn new( bucket: impl Into<String>, region: impl Into<String>, endpoint: Option<String>, credentials: CredentialSource, ) -> Result<Self>

Creates a new S3 backend.

Arguments

• bucket - The S3 bucket name
• region - AWS region (e.g., “us-east-1”)
• endpoint - Optional custom endpoint for S3-compatible services
• credentials - Credential source for authentication

Errors

Returns an error if the runtime or client cannot be created.

pub fn bucket(&self) -> &str

Returns the bucket name.

Trait Implementations

impl Debug for S3Backend

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StorageBackend for S3Backend

fn list(&self, prefix: &str) -> Result<Vec<String>>

Lists all keys with the given prefix.

fn get(&self, key: &str) -> Result<Bytes>

Reads data from the given key.

fn put(&self, key: &str, data: Bytes) -> Result<()>

Writes data to the given key.

fn delete(&self, key: &str) -> Result<()>

Deletes the given key.

fn exists(&self, key: &str) -> Result<bool>

Checks if the given key exists.

fn size(&self, key: &str) -> Result<u64>

Returns the size of the data at the given key in bytes.