FileHandler

Struct FileHandler 

Source
pub struct FileHandler { /* private fields */ }
Expand description

Handler for file operations

Provides methods for downloading, uploading, updating, and deleting files.

Implementations§

Source§

impl FileHandler

Source

pub fn new(client: FilesClient) -> Self

Creates a new FileHandler

§Arguments
  • client - FilesClient instance
Source

pub async fn download_file(&self, path: &str) -> Result<FileEntity>

Download a file or get file information

§Arguments
  • path - File path to download
§Returns

Returns a FileEntity containing file information including a download_uri for the actual file download.

§Examples
use files_sdk::{FilesClient, FileHandler};

let client = FilesClient::builder()
    .api_key("your-api-key")
    .build()?;

let handler = FileHandler::new(client);
let file = handler.download_file("/path/to/file.txt").await?;

if let Some(uri) = file.download_uri {
    println!("Download from: {}", uri);
}
Source

pub async fn get_metadata(&self, path: &str) -> Result<FileEntity>

Get file metadata only (no download URL, no logging)

This is a convenience method that calls FileActionHandler::get_metadata()

§Arguments
  • path - File path
Source

pub async fn upload_file(&self, path: &str, data: &[u8]) -> Result<FileEntity>

Upload a file (complete two-stage upload process)

This method handles the complete upload process:

  1. Calls begin_upload to get upload URLs
  2. Uploads the file data
  3. Finalizes the upload
§Arguments
  • path - Destination path for the file
  • data - File contents as bytes
§Examples
let handler = FileHandler::new(client);

let data = b"Hello, Files.com!";
let file = handler.upload_file("/uploads/test.txt", data).await?;
println!("Uploaded: {:?}", file.path);
Source

pub async fn update_file( &self, path: &str, custom_metadata: Option<HashMap<String, String>>, provided_mtime: Option<String>, priority_color: Option<String>, ) -> Result<FileEntity>

Update file metadata

§Arguments
  • path - File path
  • custom_metadata - Custom metadata key-value pairs (optional)
  • provided_mtime - Custom modification time (optional)
  • priority_color - Priority color (optional)
§Examples
let handler = FileHandler::new(client);

let mut metadata = HashMap::new();
metadata.insert("category".to_string(), "reports".to_string());

handler.update_file("/path/to/file.txt", Some(metadata), None, None).await?;
Source

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

Delete a file

§Arguments
  • path - File path to delete
  • recursive - If path is a folder, delete recursively
§Examples
let handler = FileHandler::new(client);
handler.delete_file("/path/to/file.txt", false).await?;
Source

pub async fn copy_file(&self, source: &str, destination: &str) -> Result<()>

Copy a file

This is a convenience method that calls FileActionHandler::copy_file()

§Arguments
  • source - Source file path
  • destination - Destination path
Source

pub async fn move_file(&self, source: &str, destination: &str) -> Result<()>

Move a file

This is a convenience method that calls FileActionHandler::move_file()

§Arguments
  • source - Source file path
  • destination - Destination path

Trait Implementations§

Source§

impl Clone for FileHandler

Source§

fn clone(&self) -> FileHandler

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FileHandler

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,