Gói Rust với cả thư viện và nhị phân?

Tôi muốn tạo một gói Rust chứa cả thư viện có thể sử dụng lại (nơi hầu hết chương trình được triển khai) và cũng có thể thực thi được sử dụng nó.

Giả sử tôi không nhầm lẫn bất kỳ ngữ nghĩa nào trong hệ thống mô-đun Rust, Cargo.tomltập tin của tôi sẽ trông như thế nào?

Tok:tmp doug$ du -a

8   ./Cargo.toml
8   ./src/bin.rs
8   ./src/lib.rs
16  ./src

Vận chuyển hàng hóa:

[package]
name = "mything"
version = "0.0.1"
authors = ["me <me@gmail.com>"]

[lib]
name = "mylib"
path = "src/lib.rs"

[[bin]]
name = "mybin"
path = "src/bin.rs"

src / lib.rs:

pub fn test() {
    println!("Test");
}

src / bin.rs:

extern crate mylib; // not needed since Rust edition 2018

use mylib::test;

pub fn main() {
    test();
}

Bạn cũng có thể chỉ cần đặt các nguồn nhị phân vào src/binvà phần còn lại của các nguồn của bạn src. Bạn có thể thấy một ví dụ trong dự án của tôi . Bạn hoàn toàn không cần phải sửa đổi Cargo.tomlvà mỗi tệp nguồn sẽ được biên dịch thành tệp nhị phân cùng tên.

Cấu hình của câu trả lời khác sau đó được thay thế bằng:

$ tree
.
├── Cargo.toml
└── src
    ├── bin
    │   └── mybin.rs
    └── lib.rs

Vận chuyển hàng hóa

[package]
name = "example"
version = "0.0.1"
authors = ["An Devloper <an.devloper@example.com>"]

src / lib.rs

use std::error::Error;

pub fn really_complicated_code(a: u8, b: u8) -> Result<u8, Box<Error>> {
    Ok(a + b)
}

src / bin / mybin.rs

extern crate example; // Optional in Rust 2018

fn main() {
    println!("I'm using the library: {:?}", example::really_complicated_code(1, 2));
}

Và thực hiện nó:

$ cargo run --bin mybin
I'm using the library: Ok(3)

Ngoài ra, bạn chỉ có thể tạo một src/main.rscái sẽ được sử dụng như là tệp thực thi defacto. Thật không may, điều này mâu thuẫn với cargo doclệnh:

Không thể ghi lại một gói trong đó thư viện và tệp nhị phân có cùng tên. Xem xét đổi tên một hoặc đánh dấu mục tiêu làdoc = false

Một giải pháp thay thế là không thực sự cố gắng nhồi nhét cả hai thứ vào một gói. Đối với các dự án lớn hơn một chút với khả năng thực thi thân thiện, tôi đã thấy rất tuyệt khi sử dụng không gian làm việc

Chúng tôi tạo một dự án nhị phân bao gồm một thư viện bên trong nó:

the-binary
├── Cargo.lock
├── Cargo.toml
├── mylibrary
│   ├── Cargo.toml
│   └── src
│       └── lib.rs
└── src
    └── main.rs

Vận chuyển hàng hóa

Điều này sử dụng [workspace]khóa và phụ thuộc vào thư viện:

[package]
name = "the-binary"
version = "0.1.0"
authors = ["An Devloper <an.devloper@example.com>"]

[workspace]

[dependencies]
mylibrary = { path = "mylibrary" }

src / main.rs

extern crate mylibrary;

fn main() {
    println!("I'm using the library: {:?}", mylibrary::really_complicated_code(1, 2));
}

thư viện của tôi / src / lib.rs

use std::error::Error;

pub fn really_complicated_code(a: u8, b: u8) -> Result<u8, Box<Error>> {
    Ok(a + b)
}

Và thực hiện nó:

$ cargo run
   Compiling mylibrary v0.1.0 (file:///private/tmp/the-binary/mylibrary)
   Compiling the-binary v0.1.0 (file:///private/tmp/the-binary)
    Finished dev [unoptimized + debuginfo] target(s) in 0.73 secs
     Running `target/debug/the-binary`
I'm using the library: Ok(3)

Có hai lợi ích lớn cho chương trình này:

1. Hiện tại nhị phân có thể sử dụng các phụ thuộc chỉ áp dụng cho nó. Ví dụ: bạn có thể bao gồm nhiều thùng để cải thiện trải nghiệm người dùng, chẳng hạn như trình phân tích cú pháp dòng lệnh hoặc định dạng thiết bị đầu cuối. Không ai trong số này sẽ "lây nhiễm" thư viện.

2. Không gian làm việc ngăn chặn các bản dựng dự phòng của từng thành phần. Nếu chúng tôi chạy cargo buildtrong cả thư mục mylibraryvà the-binarythư mục, thư viện sẽ không được xây dựng cả hai lần - nó được chia sẻ giữa cả hai dự án.

Bạn có thể đặt lib.rsvà main.rsvào thư mục nguồn cùng nhau. Không có xung đột và hàng hóa sẽ xây dựng cả hai thứ.

Để giải quyết xung đột tài liệu, hãy thêm vào Cargo.toml:

[[bin]]
name = "main"
doc = false