likes
comments
collection
share

如何通过cargo install安装我们的crate?

作者站长头像
站长
· 阅读数 11

我在安装tauri的开发工具时,产生一个疑问,为什么可以通过cargo安装全局命令,顺着这个线索我找到了如下方案。原理是在项目开发者指定可执行文件,也就是[[bin]],然后发布到crates.io,之后就可以通过install安装到可执行目录下,我们就能正常使用了。并不是所有crate都可以执行,而是只有在源码中声明bin的才能使用。

要让自己的crate可以通过cargo install安装,需要在crate的Cargo.toml文件中添加以下配置:

[package]
name = "your_crate_name"
version = "0.1.0"
authors = ["Your Name <your_email@example.com>"]

[dependencies]
# ...

[[bin]]
name = "your_crate_name"
path = "src/main.rs"

其中:

  • name是crate的名字,必须是唯一的。
  • version是crate的版本号,建议使用语义化版本号。
  • authors是crate的作者信息,可以省略。
  • dependencies是crate依赖的其他crate的列表。
  • bin是crate提供的可执行文件配置,可以省略。

如果省略了bin配置,cargo install将不会安装任何可执行文件,而是将crate安装到系统路径中,以便其他crate可以使用。

如果提供了bin配置,cargo install将安装指定的可执行文件到系统路径中。默认会存放到~/.cargo/bin,该路径在安装rust时被配置到PATH变量中。

此外,还可以通过以下方式让自己的crate可以通过cargo install安装:

  • 将crate发布到crates.io。
  • 将crate发布到其他crate仓库。

如果crate发布到crates.io,可以使用以下命令安装:

cargo install your_crate_name

cargo install运行从git仓库中安装可执行文件,如果crate发布到其他github仓库,可以使用以下命令安装:

cargo install --git https://github.com/your_username/your_crate_name.git

下面是一些示例:

  • 要安装一个名为hello_world的crate,可以使用以下命令:
cargo install hello_world
  • 要安装一个名为my_crate的crate,并指定可执行文件名:
cargo install my_crate --bin my_crate
  • 要安装一个发布到crates.io的crate:
cargo install serde
  • 要安装一个发布到其他crate仓库的crate:
cargo install --git https://github.com/serde-rs/serde.git

具体来说,cargo install 会执行以下操作:

  1. 下载 crate 的源代码。
  2. 编译 crate 并生成可执行文件。
  3. 将可执行文件安装到系统路径中。

总结

要想让我们自己编写的crate能够被安装到可执行文件路径中,首先要将cargo.toml中加入bin选项,其次要将crate上传到crates.io,如此一来我们的crate就能够被cargo install安装。