Struct Files 

pub struct Files<'a> { /* private fields */ }

Available on crate feature async only.

Namespace handle for the Files API.

Implementations

impl<'a> Files<'a>

pub async fn upload_path(&self, path: impl AsRef<Path>) -> Result<FileMetadata>

Upload a file from disk.

Streams the file body through the request without buffering it in memory; suitable for large PDFs.

media_type defaults to application/octet-stream. The filename is taken from the path’s file name component.

pub async fn upload_stream<R>( &self, reader: R, filename: impl Into<String>, media_type: impl Into<String>, ) -> Result<FileMetadata>

where R: AsyncRead + Send + Sync + 'static,

Upload from any AsyncRead source. The body is streamed; not buffered. Retries are not applied to uploads – the source is consumed.

pub async fn upload_bytes( &self, bytes: impl Into<Bytes>, filename: impl Into<String>, media_type: impl Into<String>, ) -> Result<FileMetadata>

Upload from a Bytes buffer (or anything that converts to Bytes). Suitable for small payloads where streaming is overkill.

pub async fn get(&self, id: &str) -> Result<FileMetadata>

Fetch metadata for a single file by ID.

pub async fn list( &self, params: ListFilesParams, ) -> Result<Paginated<FileMetadata>>

Fetch one page of file metadata.

pub async fn list_all(&self) -> Result<Vec<FileMetadata>>

Fetch every file’s metadata, transparently paging.

pub async fn delete(&self, id: &str) -> Result<FileDeleted>

Delete a file by ID. Returns the deletion confirmation.

pub async fn download(&self, id: &str) -> Result<Bytes>

Download a file’s bytes into memory. Suitable for small files; for streaming to disk or a network sink, use Self::download_to.

pub async fn download_to<W>(&self, id: &str, writer: &mut W) -> Result<u64>

where W: AsyncWrite + Unpin,

Stream a file’s bytes into any AsyncWrite sink. Returns the total number of bytes written.