Paket karat dengan pustaka dan biner?

Saya ingin membuat paket Rust yang berisi pustaka yang dapat digunakan kembali (di mana sebagian besar program diimplementasikan), dan juga sebuah executable yang menggunakannya.

Dengan asumsi saya tidak bingung semantik dalam sistem modul Rust, seperti apa Cargo.tomlfile saya ?

Tok:tmp doug$ du -a

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

Cargo.toml:

[package]
name = "mything"
version = "0.0.1"
authors = ["me <[email protected]>"]

[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();
}

Anda juga bisa memasukkan sumber biner src/bindan sisa sumber Anda src. Anda dapat melihat contoh di proyek saya . Anda tidak perlu memodifikasi Cargo.tomlsama sekali, dan setiap file sumber akan dikompilasi ke biner dengan nama yang sama.

Konfigurasi jawaban lain kemudian diganti dengan:

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

Cargo.toml

[package]
name = "example"
version = "0.0.1"
authors = ["An Devloper <[email protected]>"]

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));
}

Dan jalankan:

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

Selain itu, Anda bisa membuat src/main.rsyang akan digunakan sebagai executable defacto. Sayangnya, ini bertentangan dengan cargo docperintah:

Tidak dapat mendokumentasikan paket di mana perpustakaan dan biner memiliki nama yang sama. Pertimbangkan untuk mengganti nama atau menandai target sebagaidoc = false

Solusi alternatif adalah tidak benar-benar mencoba menjejalkan kedua hal ke dalam satu paket. Untuk proyek yang sedikit lebih besar dengan eksekusi yang ramah, saya merasa senang menggunakan ruang kerja

Kami membuat proyek biner yang menyertakan perpustakaan di dalamnya:

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

Cargo.toml

Ini menggunakan [workspace]kunci dan tergantung pada perpustakaan:

[package]
name = "the-binary"
version = "0.1.0"
authors = ["An Devloper <[email protected]>"]

[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));
}

mylibrary / src / lib.rs

use std::error::Error;

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

Dan jalankan:

$ 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)

Ada dua manfaat besar untuk skema ini:

1. Biner sekarang dapat menggunakan dependensi yang hanya berlaku untuknya. Misalnya, Anda dapat memasukkan banyak peti untuk meningkatkan pengalaman pengguna, seperti parser baris perintah atau pemformatan terminal. Tidak satu pun dari ini akan "menginfeksi" perpustakaan.

2. Ruang kerja mencegah membangun berlebihan dari setiap komponen. Jika kita menjalankan cargo buildkeduanya pada direktori mylibrarydan the-binary, perpustakaan tidak akan dibangun dua kali - itu dibagi antara kedua proyek.

Anda dapat menempatkan lib.rsdan main.rske folder sumber secara bersamaan. Tidak ada konflik dan kargo akan membangun keduanya.

Untuk menyelesaikan konflik documentaion, tambahkan ke Cargo.toml:

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