WebSocket

GitHub npm crates.io

API Reference

在 JavaScript 中使用 Rust 客户端打开 WebSocket 连接。

支持的平台

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

设置

首先安装 WebSocket 插件。

自动

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

npm

npm run tauri add websocket

yarn

yarn run tauri add websocket

pnpm

pnpm tauri add websocket

deno

deno task tauri add websocket

bun

bun tauri add websocket

cargo

cargo tauri add websocket

手动

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

   cargo add tauri-plugin-websocket

2. 修改 lib.rs 来初始化插件。

   src-tauri/src/lib.rs

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

3. 使用你喜欢的 JavaScript 包管理器安装 JavaScript Guest 绑定。

   npm

   npm install @tauri-apps/plugin-websocket

   yarn

   yarn add @tauri-apps/plugin-websocket

   pnpm

   pnpm add @tauri-apps/plugin-websocket

   deno

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

   bun

   bun add @tauri-apps/plugin-websocket

用法

WebSocket 插件可以在 JavaScript 中使用。

import WebSocket from '@tauri-apps/plugin-websocket';

const ws = await WebSocket.connect('ws://127.0.0.1:8080');

ws.addListener((msg) => {
  console.log('Received Message:', msg);
});

await ws.send('Hello World!');

await ws.disconnect();

权限

默认情况下，所有具有潜在危险的插件命令和范围都会被阻止且无法访问。您必须修改 capabilities 文件夹中的配置来启用它们。

参见能力概览以获取更多信息，以及插件的分步导览来调整插件权限。

src-tauri/capabilities/default.json

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": ["websocket:default"]
}

Default Permission

Allows connecting and sending data to a WebSocket server

This default permission set includes the following:

• allow-connect
• allow-send

Permission Table

Identifier	Description
websocket:allow-connect	Enables the connect command without any pre-configured scope.
websocket:deny-connect	Denies the connect command without any pre-configured scope.
websocket:allow-send	Enables the send command without any pre-configured scope.
websocket:deny-send	Denies the send command without any pre-configured scope.