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

A cross-platform GUI framework built on egui, the simplest way to develop GUI projects in Rust

Author: ChepleBob Language: Rust License: MIT GitHub Stars Version

English | 简体中文

Rust Constructor is an open-source project, but is not directly affiliated with the egui development team!

Table of Contents

Version Update Information

  • The current latest version is v2.4.0 Mouse Update. Major updates include:
    • Renamed FrontResource to BasicFrontResource.
    • Added an offset field to certain resources for adjusting their position (applied after position calculation).
    • Added PositionConfig for configuring resource positions.
    • Removed the get_text_size method; text size is now automatically calculated upon use and stored in the new size field of Text.
    • Added MouseDetector resource for detecting mouse actions within specific areas.
    • Added MouseDetectorLevel enum to control detection intensity and reduce performance overhead.
    • Added accompanying struct MouseDetectorResult for storing mouse detection results.
    • Extended RustConstructorError with a new error type: MouseDetectorNotFound.
    • Added a safe_mode optional parameter to nearly all functions that require resource access. When left empty, it uses the new safe_mode field in App for control. When enabled, it performs safety checks on required resources to prevent errors.
    • Fixed an issue where some Text elements couldn't be selected when multiple Texts were used.
    • Fixed index errors in Text hyperlinks when encountering emojis or other special characters.
    • Now, when Text is selected, pressing the select-all shortcut key will select the entire text block.
    • Added switched field to Switch to indicate whether the switch state was toggled by a click.
    • SwitchData has been renamed to SwitchAppearance.
    • Introduced a new SwitchData struct containing several commonly used judgment fields.
    • Replaced check_switch_click_index and check_switch_state with check_switch_data.
    • Improved parts of the codebase.
    • Fixed several known issues.

Introduction

  • Rust Constructor is a Rust GUI development library built on egui, including common features such as timers, resource storage, and error handling.
  • Rust Constructor released its first version in 2025.2, and today's Rust Constructor has undergone earth-shattering changes compared to that time.

Quick Start

  • To introduce Rust Constructor, please add rust_constructor = "x.y.z" (please replace xyz as needed) to your toml.
  • If you want to start App and perform some simple operations, it is recommended to refer to the official egui documentation.
  • Due to the large content and complex operations of Rust Constructor, it is inconvenient to fully describe here. You can refer to the official tutorial of Rust Constructor Rust Constructor Guide.

Purpose of Creating Rust Constructor

We encountered some problems that egui could not solve during the development of Targeted Vector, so we expanded many tools. To enable more people to develop conveniently, we created Rust Constructor.

Frequently Asked Questions

  • Q1: Which platforms does Rust Constructor support?

  • A1: macOS and Windows are confirmed to be fully supported, other platforms depend on egui support.

  • Q2: What are the differences between Rust Constructor V2 and V1?

  • A2: The original architecture was modified to conform to the crate structure, published on crates.io, and added an official guide.

  • Q3: Why do I get errors when calling resources?

  • A3: Please ensure you have added the resources through the add method and there are no spelling errors.

  • Q4: How to modify resources?

  • A4: You can retrieve resources via get_resource_mut.

  • Q5: What should I do if I encounter unknown error messages?

  • A5: First check the RustConstructorError definition in the Rust Constructor source code, find the problem you triggered and fix it.

  • Q6: Why is only V2 of Rust Constructor on crates.io?

  • A6: Rust Constructor V0 and Rust Constructor V1 were essentially bloated projects with many redundant features and meaningless code, so they were not published.

License

MIT © 2025 ChepleBob

Conclusion

If you like this project, please give me a star on GitHub. You can also join our organization Binder.