SuperAPI AI 工具集

rust-backend

编程与开发

查看项目

更新于 10-16 07:21

技能介绍

该技能用于在 Windmill 后端 backend/ 目录中编写或修改 Rust 代码时,套用项目专属的编码模式。

用途:约束后端 Rust 代码风格与实现方式,避免常见错误并保持向后兼容。

主要能力与约定:错误处理上使用 windmill_common::error 中的 Error,返回 Result<T, Error> 或 JsonResult<T>;库代码不得 panic,.unwrap() 仅限编译期可保证的场景。SQLx 上禁止 SELECT *,必须显式列出列名以保证 worker 落后于 API 版本时的兼容性;用 IN 子句批量查询避免 N+1;多步操作使用事务,所有查询参数化。JSON 处理优先使用 Box<serde_json::value::RawValue> 而非 serde_json::Value,仅在需要检查或修改 JSON 时才用后者。Serde 可使用 skip_serializing_if、default 等属性优化。异步并发不得阻塞运行时,CPU 密集工作使用 tokio::task::spawn_blocking;数据保护优先 std::sync::Mutex 或 parking_lot::Mutex,仅在跨 .await 持锁时用 tokio::sync::Mutex;通道使用有界的 tokio::sync::mpsc,避免在异步上下文用 std::thread::sleep。模块结构上尽量用 pub(crate) 而非 pub,按功能放置到对应 crate,API 端点按域放在 windmill-api/src/,共享功能放在 windmill-common/src/。代码导航要求使用 rust-analyzer LSP 做跳转、引用查找和类型查询,不要猜测模块路径。功能遥测方面,windmill-api-workspaces/src/workspaces.rs 中的 FEATURE_USAGE_KINDS 是允许列表,未注册的 (feature, kind) 会被静默丢弃且路由仍返回 204,详见 docs/feature-telemetry.md。Axum 处理器中直接在函数签名解构提取器。

使用方式:在编写或修改 backend/ 下 Rust 代码时应用上述模式。

限制:资料未提供安装命令、收费、价格或具体平台信息。