什么是例子,它们有什么用?
What are examples and what are they used for?
Rust 项目的目录布局应如下所示 (source)
.
├── Cargo.lock
├── Cargo.toml
├── benches
│ └── large-input.rs
├── examples
│ └── simple.rs
├── src
│ ├── bin
│ │ └── another_executable.rs
│ ├── lib.rs
│ └── main.rs
└── tests
└── some-integration-tests.rs
示例下的文件simple.rs
是什么?我如何执行它?文件应该是什么样子的?
库 crate 中的示例很有用,可以说明 crate 的使用方式。
示例可以是带有主要方法或库的可执行文件;它可以在单个文件 examples/example-name.rs
中,也可以由子目录 examples/example-name/
中的多个文件组成,主要方法在 main.rs
中。要编译库示例,您需要在 Cargo.toml
:
中指定其 crate 类型
[[example]]
name = "example-name"
crate-type = ["lib"]
示例由 cargo test
编译,以确保它们与 crate 保持同步。您可以通过
运行 一个特定的可执行示例
cargo run --example <example-name>
并使用
有选择地构建任何示例
cargo build --example <example-name>
This is documented in the Cargo Reference.
Rust 项目的目录布局应如下所示 (source)
.
├── Cargo.lock
├── Cargo.toml
├── benches
│ └── large-input.rs
├── examples
│ └── simple.rs
├── src
│ ├── bin
│ │ └── another_executable.rs
│ ├── lib.rs
│ └── main.rs
└── tests
└── some-integration-tests.rs
示例下的文件simple.rs
是什么?我如何执行它?文件应该是什么样子的?
库 crate 中的示例很有用,可以说明 crate 的使用方式。
示例可以是带有主要方法或库的可执行文件;它可以在单个文件 examples/example-name.rs
中,也可以由子目录 examples/example-name/
中的多个文件组成,主要方法在 main.rs
中。要编译库示例,您需要在 Cargo.toml
:
[[example]]
name = "example-name"
crate-type = ["lib"]
示例由 cargo test
编译,以确保它们与 crate 保持同步。您可以通过
cargo run --example <example-name>
并使用
有选择地构建任何示例cargo build --example <example-name>
This is documented in the Cargo Reference.