上传

GitHub npm crates.io

API 参考

从磁盘将文件上传到远程 HTTP 服务器。从远程 HTTP 服务器下载文件到磁盘。

支持的平台

此插件需要 Rust 版本至少为 **1.77.2**

平台	级别	备注
Windows
Linux
macOS
Android
iOS

设置

自动

使用你的项目包管理器添加依赖项

npm

npm run tauri add upload

yarn

yarn run tauri add upload

pnpm

pnpm tauri add upload

deno

deno task tauri add upload

bun

bun tauri add upload

cargo

cargo tauri add upload

手动

1. 在 src-tauri 文件夹中运行以下命令，将插件添加到项目的 Cargo.toml 依赖项中

   cargo add tauri-plugin-upload

2. 修改 lib.rs 以初始化插件

   src-tauri/src/lib.rs

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

3. 使用您首选的 JavaScript 包管理器安装 JavaScript 访客绑定

   npm

   npm install @tauri-apps/plugin-upload

   yarn

   yarn add @tauri-apps/plugin-upload

   pnpm

   pnpm add @tauri-apps/plugin-upload

   deno

   deno add npm:@tauri-apps/plugin-upload

   bun

   bun add @tauri-apps/plugin-upload

用法

完成插件的注册和设置过程后，你可以通过 JavaScript 客户端绑定访问其所有 API。

以下是如何使用插件上传和下载文件的示例

import { upload } from '@tauri-apps/plugin-upload';
// when using `"withGlobalTauri": true`, you may use
// const { upload } = window.__TAURI__.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';
// when using `"withGlobalTauri": true`, you may use
// const { download } = window.__TAURI__.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
);

Permissions

默认情况下，所有潜在危险的插件命令和范围都被阻止，无法访问。您必须修改 capabilities 配置中的权限才能启用这些功能。

有关更多信息，请参阅功能概述，并参阅分步指南以使用插件权限。

src-tauri/capabilities/default.json

{
  "permissions": [
    ...,
    "upload:default",
  ]
}

默认权限

此权限集配置了上传插件可用的操作类型。

已授予权限

默认情况下，所有操作均已启用。

此默认权限集包括以下内容

• 允许上传
• 允许下载

权限表

标识符	描述
upload:允许下载	启用下载命令，无预配置范围。
upload:拒绝下载	拒绝下载命令，无预配置范围。
upload:允许上传	启用上传命令，无预配置范围。
upload:拒绝上传	拒绝上传命令，无预配置范围。