rust-build-system-execution
Summary
Build and compile a Rust project using cargo to produce executable command-line tools or libraries. This skill is essential for preparing prototype bioinformatics software—such as mass spectrometry format converters—from source code into runnable binaries.
When to use
You have obtained a Rust source repository (e.g., mzpeak_prototyping) and need to compile it into a working command-line converter tool or library. Use this skill when the source includes a Cargo.toml manifest and you need to produce executable binaries that can read, write, or transform scientific data formats (such as converting mzML into mzPeak binary format).
When NOT to use
- The source code is not Rust; use language-specific build tools (e.g., pip for Python, npm for JavaScript, Maven for Java) instead.
- A pre-compiled binary is already available and no source modification is needed; proceed directly to execution.
- The repository lacks a Cargo.toml file or is incomplete; consult project documentation or clone a complete version first.
Inputs
- Rust source code directory with Cargo.toml manifest
- Dependency declarations in Cargo.toml and Cargo.lock (if present)
- Source files (*.rs) implementing the converter or library
Outputs
- Compiled executable binary (e.g., mzpeak_converter in target/debug/ or target/release/)
- Compiled library artifacts (.rlib or .so/.dylib files)
- Build metadata and intermediate object files in target/
How to apply
Execute cargo build at the repository root to compile the Rust project using the Cargo build system, which resolves dependencies, compiles source code, and produces binaries in the target/ directory. If optimization is required (e.g., for performance-critical converters), use cargo build --release. After a successful build, the compiled converter tool is available as an executable in target/debug/ or target/release/. Verify compilation by checking for zero error messages and confirming that the expected binary file exists with executable permissions. The build system will also validate the project's dependency graph and Rust syntax at compile time.
Related tools
Examples
cd mzpeak_prototyping && cargo build --release && ./target/release/mzpeak_converter input.mzML output.mzpeak
Evaluation signals
- Build completes with zero compiler errors and warnings (or expected warnings only)
- Executable binary exists at target/debug/ or target/release/ with executable file permissions
- Running the compiled tool without arguments or with --help displays expected command-line interface and usage instructions
- Tool successfully accepts valid input files (e.g., mzML) and produces output files in the expected format (e.g., mzPeak binary with correct structure and metadata)
- Output mzPeak files can be read by other mzPeak implementations (Python, R) without format validation errors
Limitations
- Project is in work-in-progress status with no stability guarantee; API and binary format may change between builds.
- Build requires Rust toolchain (rustc and cargo) to be installed and accessible on the system; cannot build on systems without Rust.
- Command-line interface and supported input formats are not comprehensively documented; refer to repository source code or inline help.
- The converter tool is a prototype; corner cases, edge cases in mzML input, or vendor-specific quirks may not be handled gracefully.
Evidence
- [other] Build the command-line converter tool using Rust's cargo build system.: "Build the command-line converter tool using Rust's cargo build system."
- [readme] The primary work shown here is written in Rust at the repository root, including a library for reading and writing mzPeak files, as well as command line tools for converting existing formats into mzPeak.: "The primary work shown here is written in Rust at the repository root, including a library for reading and writing mzPeak files, as well as command line tools for converting existing formats into"
- [readme] NOTE: This is a work in progress, no stability is guaranteed at this point.: "NOTE: This is a work in progress, no stability is guaranteed at this point."
- [other] Clone or obtain the mzpeak_prototyping Rust repository from github.com/mobiusklein/mzpeak_prototyping at the repository root.: "Clone or obtain the mzpeak_prototyping Rust repository from github.com/mobiusklein/mzpeak_prototyping at the repository root."
1---2name: rust-build-system-execution3description: Use when you have obtained a Rust source repository (e.g., mzpeak_prototyping) and need to compile it into a working command-line converter tool or library. Use this skill when the source includes a Cargo.4license: CC-BY-4.05---67# rust-build-system-execution89## Summary1011Build and compile a Rust project using cargo to produce executable command-line tools or libraries. This skill is essential for preparing prototype bioinformatics software—such as mass spectrometry format converters—from source code into runnable binaries.1213## When to use1415You have obtained a Rust source repository (e.g., mzpeak_prototyping) and need to compile it into a working command-line converter tool or library. Use this skill when the source includes a Cargo.toml manifest and you need to produce executable binaries that can read, write, or transform scientific data formats (such as converting mzML into mzPeak binary format).1617## When NOT to use1819- The source code is not Rust; use language-specific build tools (e.g., pip for Python, npm for JavaScript, Maven for Java) instead.20- A pre-compiled binary is already available and no source modification is needed; proceed directly to execution.21- The repository lacks a Cargo.toml file or is incomplete; consult project documentation or clone a complete version first.2223## Inputs2425- Rust source code directory with Cargo.toml manifest26- Dependency declarations in Cargo.toml and Cargo.lock (if present)27- Source files (*.rs) implementing the converter or library2829## Outputs3031- Compiled executable binary (e.g., mzpeak_converter in target/debug/ or target/release/)32- Compiled library artifacts (.rlib or .so/.dylib files)33- Build metadata and intermediate object files in target/3435## How to apply3637Execute `cargo build` at the repository root to compile the Rust project using the Cargo build system, which resolves dependencies, compiles source code, and produces binaries in the `target/` directory. If optimization is required (e.g., for performance-critical converters), use `cargo build --release`. After a successful build, the compiled converter tool is available as an executable in `target/debug/` or `target/release/`. Verify compilation by checking for zero error messages and confirming that the expected binary file exists with executable permissions. The build system will also validate the project's dependency graph and Rust syntax at compile time.3839## Related tools4041- **Rust** (Programming language and compiler for building the mzPeak converter and library) — https://github.com/rust-lang/rust42- **Cargo** (Rust package manager and build system used to compile the project) — https://github.com/rust-lang/cargo43- **mzpeak_prototyping** (Rust project containing command-line tools and libraries for mzPeak format conversion) — https://github.com/mobiusklein/mzpeak_prototyping4445## Examples4647```48cd mzpeak_prototyping && cargo build --release && ./target/release/mzpeak_converter input.mzML output.mzpeak49```5051## Evaluation signals5253- Build completes with zero compiler errors and warnings (or expected warnings only)54- Executable binary exists at target/debug/<tool_name> or target/release/<tool_name> with executable file permissions55- Running the compiled tool without arguments or with --help displays expected command-line interface and usage instructions56- Tool successfully accepts valid input files (e.g., mzML) and produces output files in the expected format (e.g., mzPeak binary with correct structure and metadata)57- Output mzPeak files can be read by other mzPeak implementations (Python, R) without format validation errors5859## Limitations6061- Project is in work-in-progress status with no stability guarantee; API and binary format may change between builds.62- Build requires Rust toolchain (rustc and cargo) to be installed and accessible on the system; cannot build on systems without Rust.63- Command-line interface and supported input formats are not comprehensively documented; refer to repository source code or inline help.64- The converter tool is a prototype; corner cases, edge cases in mzML input, or vendor-specific quirks may not be handled gracefully.6566## Evidence6768- [other] Build the command-line converter tool using Rust's cargo build system.: "Build the command-line converter tool using Rust's cargo build system."69- [readme] The primary work shown here is written in Rust at the repository root, including a library for reading and writing mzPeak files, as well as command line tools for converting existing formats into mzPeak.: "The primary work shown here is written in Rust at the repository root, including a library for reading and writing mzPeak files, as well as command line tools for converting existing formats into"70- [readme] NOTE: This is a work in progress, no stability is guaranteed at this point.: "NOTE: This is a **work in progress**, no stability is guaranteed at this point."71- [other] Clone or obtain the mzpeak_prototyping Rust repository from github.com/mobiusklein/mzpeak_prototyping at the repository root.: "Clone or obtain the mzpeak_prototyping Rust repository from github.com/mobiusklein/mzpeak_prototyping at the repository root."
HolobiomicsLab