Rust Package Management

Cargo

Generate Documentation

Cargo is able to generate documentation from all the doc comments in crate. To do that run:

cargo doc --open

Profiles

release profiles are predefined and customizable profiles with different configurations that allow a programmer to have more control over various options for compiling code.

  • dev profile cargo uses when you run cargo build
  • release profile cargo uses when you run cargo build --release

Cargo has default settings for each of the profiles that apply when there aren’t any [profile.*] sections in the project’s Cargo.toml file. By adding [profile.*] sections for any profile you want to customize, you can override any subset of the default settings. 

[profile.dev]
opt-level = 0

[profile.release]
opt-level = 3

The opt-level setting controls the number of optimizations Rust will apply to your code, with a range of 0 to 3.

Build And Release

To build Rust code use following command:

cargo build <options>

Here are some of the useful options, which could be used with build command:

  • --lib build package's library code
  • --bins build package's executable binaries. Also it is possible to specify particular binaries with --bin <name> option
  • --examples build all examples
  • --target <name> build for specified target architecture
  • --release build in release mode with all optimisations
  • --target-dit specify directory to put build outputs
  • --verbose log all details during build process
  • --quite don't log any details during build process
  • --message-format specifies format of outputting build logs
  • --jobs specifies amount of parallel processes of build
  • ``

Publishing

To publish modules into crates.io need at first to register on it with github account. On the second step need to generate new API token. It is possible to do on https://crates.io/settings/tokens page. Pressing New Token button, system will ask for a name of a new token and after will return freshly generated token.

To use it run cargo login <api-token> in the terminal or CI. Then token will be stored inside of ~/.cargo/credentials.

To be eligible for publish on crates.io, package should have a unique name, have a description and license. It can be specified inside of Cargo.toml file: 

[package]
name = "guessing_game"
version = "0.1.0"
edition = "2022"
description = "some package description"
license = "MIT"

After all metadata is set correctly run cargo publish. This will publish the package to the crates.io.

Published packages could not be edited or removed. This is made to ensure that all code, using this package will be functional in future. But it is pussible to mark package as depricated by cargo yank --vers 1.0.1 so future projects will not use it. cargo yank --vers 1.0.1 --undo will do the opposite.

There is no limitation for publishing new version though. To do that required to change version in Cargo.toml file.

References