开源项目 `readonly` 使用教程

开源项目 readonly 使用教程

readonlyStruct fields that are made read-only accessible to other modules项目地址:https://gitcode.com/gh_mirrors/re/readonly

1. 项目的目录结构及介绍

readonly/
├── Cargo.toml
├── LICENSE
├── README.md
├── src/
│   ├── lib.rs
│   └── main.rs
└── tests/
    └── test.rs

• Cargo.toml: 项目的依赖和元数据配置文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的基本介绍和使用说明。
• src/: 源代码目录。
  • lib.rs: 库文件，定义了 readonly 宏。
  • main.rs: 主程序文件，展示了如何使用 readonly 宏。
• tests/: 测试代码目录。
  • test.rs: 测试文件，用于测试 readonly 宏的功能。

2. 项目的启动文件介绍

项目的启动文件是 src/main.rs。该文件展示了如何使用 readonly 宏来创建只读结构体。以下是 src/main.rs 的部分代码示例：

use readonly::readonly;

#[readonly::make]
struct Foo {
    bar: i32,
}

fn main() {
    let foo = Foo { bar: 42 };
    println!("{}", foo.bar);
}

3. 项目的配置文件介绍

项目的配置文件是 Cargo.toml。该文件包含了项目的依赖、版本信息和其他元数据。以下是 Cargo.toml 的部分内容示例：

[package]
name = "readonly"
version = "0.1.0"
authors = ["David Tolnay <dtolnay@gmail.com>"]
edition = "2018"

[dependencies]

这个配置文件指定了项目的名称、版本、作者和使用的 Rust 版本，并列出了项目的依赖。

readonlyStruct fields that are made read-only accessible to other modules项目地址:https://gitcode.com/gh_mirrors/re/readonly