rust-constructor 2.4.0

A cross-platform GUI framework built on egui, the simplest way to develop GUI projects in Rust.
Documentation
# `Rust Constructor V2`

## 基于`egui`构建的跨平台`GUI`框架, 用`Rust`开发`GUI`项目最简单的方式

[![作者: ChepleBob](https://img.shields.io/badge/作者-ChepleBob-00B4D8)](https://github.com/ChepleBob30)
[![语言: Rust](https://img.shields.io/badge/语言-Rust-5F4C49)](https://www.rust-lang.org/)
[![许可证: MIT](https://img.shields.io/badge/许可证-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![Github 星星](https://img.shields.io/github/stars/ChepleBob30/Rust-Constructor?style=flat&color=red)
[![版本](https://img.shields.io/badge/版本-v2.4.0-421463)](https://github.com/ChepleBob30/Rust-Constructor/releases)

[English]./README.md | 简体中文

---

`Rust Constructor`是开源项目,但与`egui`开发组无直接关系!

## 目录

- [版本更新信息]#版本更新信息
- [简介]#简介
- [快速上手]#快速上手
- [创造Rust Constructor的目的]#创造rust-constructor的目的
- [常见问题]#常见问题
- [许可证]#许可证
- [尾声]#尾声

---

## 版本更新信息

- 目前的最新版本为`v2.4.0 鼠标更新`。主要更新了以下内容:
  - 重命名`FrontResource``BasicFrontResource`  - 为部分资源添加了`offset`字段,用于改变资源位置(在完成位置计算后进行操作)。
  - 添加了`PositionConfig`,用于配置资源位置。
  - 移除了`get_text_size`方法,改为在调用时自动计算并添加到`Text`的新字段`size`中。
  - 新增`MouseDetector`(鼠标检测器)资源,用于检查特定范围内鼠标的操作。
  - 新增枚举`MouseDetectorLevel`,可以控制检测量,从而减少性能损耗。
  - 新增配套结构体`MouseDetectorResult`,用于储存鼠标检测结果。
  - 扩展了一个`RustConstructorError`错误类型: `MouseDetectorNotFound`  - 为几乎所有需要调用资源的函数添加`safe_mode`可选项,留空即可使用`App`的新字段`safe_mode`进行控制,开启后可以对所有需要使用的资源进行安全检查,避免报错。
  - 修复了在使用多个`Text`时部分`Text`无法框选的问题。
  - 修复了`Text`的超链接遇到表情符号等文本时索引错误的问题。
  - 现在`Text`在框选后按下全选组合键即可将整段文本选中。
  - `Switch`新增`switched`字段,用于判定是否点击切换了开关状态。
  - `SwitchData`已被重命名为`SwitchAppearance`  - 新增`SwitchData`结构体,包含几个常用判定字段。
  - `check_switch_click_index``check_switch_state`现已被`check_switch_data`取代。
  - 完善了部分代码。
  - 修复了一些已知问题。

---

## 简介

- `Rust Constructor`是一个基于egui搭建的Rust图形化开发库,包含了计时器、资源存储、错误处理等常用功能。
- `Rust Constructor``2025.2`发布了第一个版本,今天的`Rust Constructor`相较于那时有了翻天覆地的变化。

---

## 快速上手

- 若想引入`Rust Constructor`,请添加`rust_constructor = "x.y.z"`(请根据需要自行替换xyz)到`toml`中。
- 如果想要启动`App`并进行一些简单的操作,建议查阅[egui的官方文档]https://github.com/emilk/egui- 由于`Rust Constructor`的内容量较大且操作复杂,这里不方便完整进行叙述。你可以参考`Rust Constructor`的官方教程[Rust Constructor 指南]https://github.com/ChepleBob30/Rust-Constructor-Guide
---

## 创造Rust Constructor的目的

我们在开发[靶向载体](https://github.com/ChepleBob30/Targeted-Vector)的过程中遇到了一些`egui`无法解决的问题,因此我们拓展了许多工具。为了能让更多人便利地进行开发,我们就创造了`Rust Constructor`。

---

## 常见问题

- Q1: `Rust Constructor`支持哪些平台?

- A1: `macOS``Windows`已确认完全支持,其他平台视`egui`支持情况而定。

- Q2: `Rust Constructor V2`比起`V1`有什么区别?

- A2: 将原先的架构修改为了符合库`crate`的结构,发布在了[crates.io]https://crates.io/上,并添加了官方指南。

- Q3: 为什么我调用资源就会报错?

- A3: 请确保你已经通过`add`方法添加了资源,并且没有拼写错误。

- Q4: 如何修改资源?

- A4: 通过`get_resource_mut`取出资源即可。

- Q5: 如果出现未知的报错提示该怎么办?

- A5: 优先查看`Rust Constructor`源代码中的`RustConstructorError`定义处,找到你触发的问题并修正。

- Q6: 为什么`Rust Constructor``crates.io`上只有`V2`
- A6: `Rust Constructor V0``Rust Constructor V1`本质上是一个臃肿的项目,有很多冗余的功能和无意义的代码,所以并未发布。

---

## 许可证

[MIT](./LICENSE-MIT) © 2025 ChepleBob

## 尾声

如果你喜欢这个项目,请在`GitHub`上给我点个`star`。你也可以加入我们的组织[必达](https://github.com/Binder-organize)。