Struct StorageBucketApi 

pub struct StorageBucketApi { /* private fields */ }

File operations API scoped to a specific bucket.

Created via StorageClient::from("bucket_name").

Example

let file_api = storage.from("avatars");
file_api.upload("photo.png", data, FileOptions::new()).await?;
let bytes = file_api.download("photo.png").await?;

Implementations

impl StorageBucketApi

pub async fn upload( &self, path: &str, data: Vec<u8>, options: FileOptions, ) -> Result<UploadResponse, StorageError>

Upload a file to the bucket.

Mirrors supabase.storage.from('bucket').upload(path, file, options).

pub async fn update( &self, path: &str, data: Vec<u8>, options: Option<FileOptions>, ) -> Result<UploadResponse, StorageError>

Update (replace) a file in the bucket.

Mirrors supabase.storage.from('bucket').update(path, file, options).

pub async fn download(&self, path: &str) -> Result<Vec<u8>, StorageError>

Download a file from the bucket.

Returns the raw file bytes.

pub async fn list( &self, path: Option<&str>, options: Option<SearchOptions>, ) -> Result<Vec<FileObject>, StorageError>

List files in the bucket.

path is the folder prefix (e.g., "folder" or None for root).

pub async fn move_file(&self, from: &str, to: &str) -> Result<(), StorageError>

Move a file within the bucket.

Mirrors supabase.storage.from('bucket').move(from, to).

pub async fn copy(&self, from: &str, to: &str) -> Result<String, StorageError>

Copy a file within the bucket.

Returns the key of the new file.

pub async fn remove( &self, paths: Vec<&str>, ) -> Result<Vec<FileObject>, StorageError>

Remove files from the bucket.

Mirrors supabase.storage.from('bucket').remove([paths]).

pub async fn create_signed_url( &self, path: &str, expires_in: u64, ) -> Result<SignedUrlResponse, StorageError>

Create a signed URL for time-limited access to a file.

expires_in is the number of seconds until the URL expires.

pub async fn create_signed_urls( &self, paths: Vec<&str>, expires_in: u64, ) -> Result<Vec<SignedUrlBatchEntry>, StorageError>

Create signed URLs for multiple files.

expires_in is the number of seconds until the URLs expire.

pub fn get_public_url(&self, path: &str) -> String

Get the public URL for a file (no HTTP call, just URL construction).

Only works for files in public buckets.

pub async fn create_signed_upload_url( &self, path: &str, ) -> Result<SignedUploadUrlResponse, StorageError>

Create a signed upload URL for delegated uploads.

pub async fn upload_to_signed_url( &self, token: &str, path: &str, data: Vec<u8>, options: Option<FileOptions>, ) -> Result<(), StorageError>

Upload a file using a previously created signed upload URL.

pub async fn info(&self, path: &str) -> Result<FileInfo, StorageError>

Get file metadata.

Mirrors supabase.storage.from('bucket').info(path).

pub async fn exists(&self, path: &str) -> Result<bool, StorageError>

Check if a file exists.

Mirrors supabase.storage.from('bucket').exists(path). Returns true if the file exists, false if it does not (404).

pub async fn download_with_transform( &self, path: &str, transform: &TransformOptions, ) -> Result<Vec<u8>, StorageError>

Download with server-side image transformation.

Mirrors supabase.storage.from('bucket').download(path, { transform }).

pub fn get_public_url_with_transform( &self, path: &str, transform: &TransformOptions, ) -> String

Get public URL with image transformation (no HTTP call).

Mirrors supabase.storage.from('bucket').getPublicUrl(path, { transform }).

pub async fn create_signed_url_with_transform( &self, path: &str, expires_in: u64, transform: &TransformOptions, ) -> Result<SignedUrlResponse, StorageError>

Create a signed URL with image transformation.

Mirrors supabase.storage.from('bucket').createSignedUrl(path, expiresIn, { transform }).

pub async fn create_signed_urls_with_transform( &self, paths: Vec<&str>, expires_in: u64, transform: &TransformOptions, ) -> Result<Vec<SignedUrlBatchEntry>, StorageError>

Create batch signed URLs with image transformation.

Mirrors supabase.storage.from('bucket').createSignedUrls(paths, expiresIn, { transform }).

pub async fn move_to_bucket( &self, from: &str, to_bucket: &str, to_path: &str, ) -> Result<(), StorageError>

Move a file to a different bucket.

Mirrors supabase.storage.from('bucket').move(from, to, { destinationBucket }).

pub async fn copy_to_bucket( &self, from: &str, to_bucket: &str, to_path: &str, ) -> Result<String, StorageError>

Copy a file to a different bucket.

Returns the key of the new file.

Mirrors supabase.storage.from('bucket').copy(from, to, { destinationBucket }).

pub fn get_public_url_with_download( &self, path: &str, filename: Option<&str>, ) -> String

Get a public URL with optional download disposition.

When filename is Some("file.txt"), appends ?download=file.txt to the URL. When filename is Some(""), appends ?download= (uses original filename).

Mirrors supabase.storage.from('bucket').getPublicUrl(path, { download }).

pub async fn create_signed_url_with_download( &self, path: &str, expires_in: u64, filename: Option<&str>, ) -> Result<SignedUrlResponse, StorageError>

Create a signed URL with optional download disposition.

When filename is Some("file.txt"), appends &download=file.txt to the signed URL. When filename is Some(""), appends &download= (uses original filename).

Mirrors supabase.storage.from('bucket').createSignedUrl(path, expiresIn, { download }).

pub fn bucket_id(&self) -> &str

Get the bucket ID this API is scoped to.

Trait Implementations

impl Clone for StorageBucketApi

fn clone(&self) -> StorageBucketApi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StorageBucketApi

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

Formats the value using the given formatter.