Package Rust avec à la fois une bibliothèque et un binaire?

Je voudrais créer un package Rust contenant à la fois une bibliothèque réutilisable (où la plupart du programme est implémenté) et un exécutable qui l'utilise.

En supposant que je n'ai confondu aucune sémantique dans le système de modules Rust, à quoi mon Cargo.tomlfichier devrait-il ressembler?

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

Vous pouvez également simplement insérer des sources binaires src/binet le reste de vos sources src. Vous pouvez voir un exemple dans mon projet . Vous n'avez pas du tout besoin de modifier votre Cargo.toml, et chaque fichier source sera compilé dans un binaire du même nom.

La configuration de l'autre réponse est alors remplacée par:

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

Et exécutez-le:

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

De plus, vous pouvez simplement créer un src/main.rsfichier qui sera utilisé comme exécutable de facto. Malheureusement, cela entre en conflit avec la cargo doccommande:

Impossible de documenter un package dans lequel une bibliothèque et un binaire ont le même nom. Envisagez d'en renommer un ou de marquer la cible commedoc = false

Une autre solution consiste à ne pas essayer de regrouper les deux choses dans un seul paquet. Pour les projets légèrement plus grands avec un exécutable convivial, j'ai trouvé très agréable d'utiliser un espace de travail

Nous créons un projet binaire qui comprend une bibliothèque à l'intérieur:

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

Cargo.toml

Cela utilise la [workspace]clé et dépend de la bibliothèque:

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

Et exécutez-le:

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

Il y a deux grands avantages à ce programme:

1. Le binaire peut désormais utiliser des dépendances qui ne s'appliquent qu'à lui. Par exemple, vous pouvez inclure de nombreuses caisses pour améliorer l'expérience utilisateur, telles que des analyseurs de ligne de commande ou le formatage du terminal. Aucun de ceux-ci ne «infectera» la bibliothèque.

2. L'espace de travail empêche les versions redondantes de chaque composant. Si nous exécutons cargo buildà la fois le répertoire mylibraryet the-binary, la bibliothèque ne sera pas créée les deux fois - elle est partagée entre les deux projets.

Vous pouvez mettre lib.rset main.rsvers le dossier sources ensemble. Il n'y a pas de conflit et la cargaison construira les deux choses.

Pour résoudre un conflit de documentaion, ajoutez à votre Cargo.toml:

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