Какие примеры и для чего они используются?

Question

Макет каталога проекта 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 в примерах? Как мне это выполнить? Как должен выглядеть файл?

Answer 1

Примеры полезны в ящиках библиотеки, чтобы показать, как используется ящик.

Примером может быть исполняемый файл с методом main или библиотека; он может быть либо в одном файле examples/example-name.rs, либо состоять из нескольких файлов в подкаталоге examples/example-name/ с методом main в main.rs. Чтобы скомпилировать пример библиотеки, вам нужно указать ее тип ящика в Cargo.toml:

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

Примеры составлены cargo test, чтобы обеспечить их актуальность с ящиком. Вы можете запустить конкретный исполняемый пример, набрав

cargo run --example <example-name>

и выборочно создайте любой пример с

cargo build --example <example-name>

Это задокументировано в справочном документе .