Upload

GitHub npm crates.io

API Reference

Upload files from disk to a remote server over HTTP. Download files from a remote HTTP server to disk.

Setup

This plugin requires a Rust version of at least 1.75

Automatic

Use your project’s package manager to add the dependency:

npm

npm run tauri add upload

Yarn

yarn run tauri add upload

pnpm

pnpm tauri add upload

Cargo

cargo tauri add upload

Manual

1. Run cargo add tauri-plugin-upload to add the plugin to the project’s dependencies in Cargo.toml.

2. Modify lib.rs to initialize the plugin:

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pb fn run() {
     tauri::Builder::default()
       // Initialize the plugin
       .plugin(tauri_plugin_upload::init())
       .run(tauri::generate_context!())
       .expect("error while running tauri application");
   }

3. Install the JavaScript Guest bindings using your preferred JavaScript package manager:

   npm

   npm install @tauri-apps/plugin-upload

   Yarn

   yarn add @tauri-apps/plugin-upload

   pnpm

   pnpm add @tauri-apps/plugin-upload

Usage

Once you’ve completed the registration and setup process for the plugin, you can access all of its APIs through the JavaScript guest bindings.

Here’s an example of how you can use the plugin to upload and download files:

import { upload } from '@tauri-apps/plugin-upload';

upload(
  'https://example.com/file-upload',
  './path/to/my/file.txt',
  (progress, total) => console.log(`Uploaded ${progress} of ${total} bytes`), // a callback that will be called with the upload progress
  { 'Content-Type': 'text/plain' } // optional headers to send with the request
);

import { download } from '@tauri-apps/plugin-upload';

download(
  'https://example.com/file-download-link',
  './path/to/save/my/file.txt',
  (progress, total) => console.log(`Downloaded ${progress} of ${total} bytes`), // a callback that will be called with the download progress
  { 'Content-Type': 'text/plain' } // optional headers to send with the request
);