什么是示例,它们用于什么？

Question

Rust项目的目录布局应如下所示(源代码)

.
??? 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示例下的文件是什么？我该如何执行？该文件应该如何？

Answer 1

库 crate 中的示例非常有用，可以展示如何使用 crate。

示例可以是带有 main 方法或库的可执行文件；它可以位于单个文件中examples/example-name.rs，也可以由子目录中的多个文件组成examples/example-name/，其中 main 方法位于main.rs. 要编译库示例，您需要在以下位置指定其包类型Cargo.toml：

[[example]]
name = "example-name"
crate-type = ["lib"]

示例的编译是为了cargo test确保它们与 crate 保持同步。您可以通过以下方式运行特定的可执行示例

cargo run --example <example-name>

并选择性地构建任何示例

cargo build --example <example-name>

这记录在货物参考中。