var Component=(()=>{var m=Object.create;var i=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var u=Object.getOwnPropertyNames;var g=Object.getPrototypeOf,N=Object.prototype.hasOwnProperty;var k=(a,e)=>()=>(e||a((e={exports:{}}).exports,e),e.exports),b=(a,e)=>{for(var l in e)i(a,l,{get:e[l],enumerable:!0})},r=(a,e,l,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let c of u(e))!N.call(a,c)&&c!==l&&i(a,c,{get:()=>e[c],enumerable:!(s=p(e,c))||s.enumerable});return a};var y=(a,e,l)=>(l=a!=null?m(g(a)):{},r(e||!a||!a.__esModule?i(l,"default",{value:a,enumerable:!0}):l,a)),f=a=>r(i({},"__esModule",{value:!0}),a);var o=k((C,t)=>{t.exports=_jsx_runtime});var v={};b(v,{default:()=>h,frontmatter:()=>w});var n=y(o()),w={title:"Rust Development Environment",date:"2025-05-20",language:"en",series:{order:1,title:"rust"},tags:["rust","swc","mono repo"],authors:["default"],featured:!0,images:["/static/images/twitter-card.png"],summary:"Discover how to set up a Rust development environment, manage projects with Cargo and workspaces, write tests, and publish your crates."};function d(a){let e={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",span:"span",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...a.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(e.p,{children:"Rustup is a tool for managing Rust versions and associated tools. This guide will walk you through setting up your Rust development environment, understanding core tools, developing packages, testing, and publishing."}),(0,n.jsx)(e.h2,{id:"-core-components-of-the-rust-toolchain",children:"\u{1F980} Core Components of the Rust Toolchain"}),(0,n.jsx)(e.h3,{id:"1-rustc--the-rust-compiler",children:"1. rustc \u2014 The Rust Compiler"}),(0,n.jsxs)(e.ul,{children:[(0,n.jsx)(e.li,{children:"Purpose: Compiles Rust source code into executable files or libraries."}),(0,n.jsx)(e.li,{children:"Usage:"})]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsx)(e.span,{className:"code-line line-number",line:"1",children:`rustc main.rs `})})}),(0,n.jsxs)(e.p,{children:["This will compile ",(0,n.jsx)(e.code,{children:"main.rs"})," into a binary executable file named ",(0,n.jsx)(e.code,{children:"main"})," (or ",(0,n.jsx)(e.code,{children:"main.exe"})," on Windows)."]}),(0,n.jsx)(e.ul,{children:(0,n.jsxs)(e.li,{children:["Features:",(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Strong type system and ownership model"}),": Catches many errors at compile time."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"High performance"}),": Compiled artifacts typically have performance comparable to C/C++."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Memory safety"}),": Guarantees memory safety without a garbage collector."]}),(0,n.jsx)(e.li,{children:"Supports static linking (by default, generates executables without external Rust runtime dependencies)."}),(0,n.jsxs)(e.li,{children:["Supports ",(0,n.jsx)(e.code,{children:"--emit"})," to output intermediate artifacts (like LLVM IR, ASM, etc.)."]})]})]})}),(0,n.jsx)(e.h3,{id:"2-cargo--rust-package-manager-and-build-system",children:"2. Cargo \u2014 Rust Package Manager and Build System"}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.p,{children:"Purpose:"}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Project initialization"}),": ",(0,n.jsx)(e.code,{children:"cargo new "})," (binary application) or ",(0,n.jsx)(e.code,{children:"cargo new --lib "})," (library)."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Compilation and building"}),": ",(0,n.jsx)(e.code,{children:"cargo build"})," (development mode) / ",(0,n.jsx)(e.code,{children:"cargo build --release"})," (optimized mode)."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Running programs"}),": ",(0,n.jsx)(e.code,{children:"cargo run"})," (compiles and runs binary targets)."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Testing code"}),": ",(0,n.jsx)(e.code,{children:"cargo test"})," (runs all unit tests and integration tests)."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Managing dependencies"}),": Edit the ",(0,n.jsx)(e.code,{children:"Cargo.toml"})," file, and Cargo will automatically download and compile dependency packages (crates) from ",(0,n.jsx)(e.code,{children:"crates.io"}),"."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Document generation"}),": ",(0,n.jsx)(e.code,{children:"cargo doc --open"})," (generates documentation for the project and its dependencies and opens it in a browser)."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Publishing packages"}),": ",(0,n.jsx)(e.code,{children:"cargo publish"})," (publishes a library to ",(0,n.jsx)(e.code,{children:"crates.io"}),")."]})]})]}),(0,n.jsx)(e.li,{children:(0,n.jsx)(e.p,{children:"Usage:"})})]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsxs)(e.code,{className:"language-bash code-highlight",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Create a new binary project"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"}),` new hello_world `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[(0,n.jsx)(e.span,{className:"token class-name builtin",children:"cd"}),` hello_world `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"4",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Edit src/main.rs"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# fn main() {"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"7",children:[(0,n.jsx)(e.span,{className:"token comment",children:'# println!("Hello, world!");'}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# }"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"9",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"10",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Compile and run"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"11",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"}),` run `]})]})}),(0,n.jsx)(e.ul,{children:(0,n.jsxs)(e.li,{children:["Features:",(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Convention over configuration"}),": Follows a standard project structure (e.g., ",(0,n.jsx)(e.code,{children:"src/main.rs"}),", ",(0,n.jsx)(e.code,{children:"src/lib.rs"}),", ",(0,n.jsx)(e.code,{children:"Cargo.toml"}),")."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Integrated build system"}),": Handles all aspects like compilation, testing, dependency management, etc."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Reproducible builds"}),": The ",(0,n.jsx)(e.code,{children:"Cargo.lock"})," file ensures that the same versions of dependencies are used for every build."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.strong,{children:["Supports publishing to ",(0,n.jsx)(e.code,{children:"crates.io"})]}),": Rust's official package registry."]})]})]})}),(0,n.jsx)(e.h3,{id:"3-rustup--rust-toolchain-installer-and-manager",children:"3. rustup \u2014 Rust Toolchain Installer and Manager"}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.p,{children:"Purpose:"}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Installing Rust"}),": Includes core components like ",(0,n.jsx)(e.code,{children:"rustc"})," (compiler), ",(0,n.jsx)(e.code,{children:"cargo"})," (package manager), ",(0,n.jsx)(e.code,{children:"rust-std"})," (standard library), etc."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Managing multiple versions of Rust toolchains"}),": Such as ",(0,n.jsx)(e.code,{children:"stable"}),", ",(0,n.jsx)(e.code,{children:"beta"}),", ",(0,n.jsx)(e.code,{children:"nightly"}),", and specific version numbers."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Updating toolchains"}),": ",(0,n.jsx)(e.code,{children:"rustup update"}),"."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Installing additional components"}),": Such as ",(0,n.jsx)(e.code,{children:"rustfmt"})," (code formatter), ",(0,n.jsx)(e.code,{children:"clippy"})," (static code analysis), ",(0,n.jsx)(e.code,{children:"rust-analyzer"})," (LSP server support), etc."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Managing cross-compilation targets"}),": ",(0,n.jsx)(e.code,{children:"rustup target add "}),"."]})]})]}),(0,n.jsx)(e.li,{children:(0,n.jsx)(e.p,{children:"Usage:"})})]}),(0,n.jsx)(e.p,{children:"Installing and switching toolchains:"}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsxs)(e.code,{className:"language-bash code-highlight",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Install the stable version (usually the default operation for a first-time install)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# (The command above can be found on the official website and will guide you through the installation)"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"4",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# View installed toolchains"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"6",children:`rustup show `}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"7",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Install the nightly toolchain"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"9",children:["rustup ",(0,n.jsx)(e.span,{className:"token function",children:"install"}),` nightly `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"10",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"11",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Set the global default toolchain"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"12",children:`rustup default stable `}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"13",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"14",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Override the default toolchain for the current project (execute in the project directory)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"15",children:["rustup override ",(0,n.jsx)(e.span,{className:"token class-name builtin",children:"set"}),` nightly `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"16",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"17",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Update all installed toolchains"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"18",children:`rustup update `})]})}),(0,n.jsx)(e.p,{children:"Component management:"}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsxs)(e.code,{className:"language-bash code-highlight",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Add rustfmt and clippy components to the default toolchain"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:["rustup component ",(0,n.jsx)(e.span,{className:"token function",children:"add"}),` rustfmt clippy `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"3",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Add wasm compilation target"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:["rustup target ",(0,n.jsx)(e.span,{className:"token function",children:"add"}),` wasm32-unknown-unknown `]})]})}),(0,n.jsx)(e.ul,{children:(0,n.jsxs)(e.li,{children:["Features:",(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Multiple versions coexisting and switchable"}),": Easily switch between different Rust versions to meet various project needs."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Flexible switching scope"}),": Supports global default or project-specific toolchain designation."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Officially recommended"}),": The standard way to install and manage Rust."]})]})]})}),(0,n.jsx)(e.h3,{id:"-commonly-used-extension-tools",children:"\u{1F527} Commonly Used Extension Tools"}),(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{children:"Tool"}),(0,n.jsx)(e.th,{children:"Description"}),(0,n.jsx)(e.th,{children:"Usage (after installation)"}),(0,n.jsx)(e.th,{children:"Installation Command (if not a rustup component)"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo-edit"})}),(0,n.jsxs)(e.td,{children:["Enhances cargo, manage ",(0,n.jsx)(e.code,{children:"Cargo.toml"})," dependencies via command line (",(0,n.jsx)(e.code,{children:"add"}),", ",(0,n.jsx)(e.code,{children:"rm"}),", ",(0,n.jsx)(e.code,{children:"upgrade"}),")"]}),(0,n.jsxs)(e.td,{children:[(0,n.jsx)(e.code,{children:"cargo add "}),", ",(0,n.jsx)(e.code,{children:"cargo rm "})]}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo install cargo-edit"})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"clippy"})}),(0,n.jsx)(e.td,{children:"Rust code static analysis, provides improvement suggestions and lint checks"}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo clippy"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"rustup component add clippy"})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"rustfmt"})}),(0,n.jsx)(e.td,{children:"Automatic code formatting tool, maintains consistent code style"}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo fmt"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"rustup component add rustfmt"})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"rust-analyzer"})}),(0,n.jsx)(e.td,{children:"LSP language server, provides IDEs (like VS Code) with IntelliSense, autocompletion, diagnostics, etc."}),(0,n.jsx)(e.td,{children:"Automatic integration by editor or plugin installation"}),(0,n.jsxs)(e.td,{children:[(0,n.jsx)(e.code,{children:"rustup component add rust-analyzer"})," (Usually guided by editor plugins)"]})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo doc"})}),(0,n.jsx)(e.td,{children:"Generates documentation for the project and dependencies"}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo doc --open"})}),(0,n.jsx)(e.td,{children:"(Built into Cargo)"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo bench"})}),(0,n.jsx)(e.td,{children:"Performance benchmarking tool"}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo bench"})}),(0,n.jsx)(e.td,{children:"(Built into Cargo)"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo test"})}),(0,n.jsx)(e.td,{children:"Unit and integration test runner"}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo test"})}),(0,n.jsx)(e.td,{children:"(Built into Cargo)"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"wasm-pack"})}),(0,n.jsx)(e.td,{children:"Builds and packages Rust-generated WebAssembly"}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"wasm-pack build --target web"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo install wasm-pack"})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo-audit"})}),(0,n.jsx)(e.td,{children:"Checks project dependencies for known security vulnerabilities"}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo audit"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo install cargo-audit"})})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo-watch"})}),(0,n.jsxs)(e.td,{children:["Automatically executes cargo commands (like ",(0,n.jsx)(e.code,{children:"check"}),", ",(0,n.jsx)(e.code,{children:"clippy"}),", ",(0,n.jsx)(e.code,{children:"test"}),", ",(0,n.jsx)(e.code,{children:"run"}),") on file changes"]}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo watch -x check"})}),(0,n.jsx)(e.td,{children:(0,n.jsx)(e.code,{children:"cargo install cargo-watch"})})]})]})]}),(0,n.jsx)(e.h2,{id:"-setting-up-the-rust-development-environment",children:"\u{1F980} Setting Up the Rust Development Environment"}),(0,n.jsxs)(e.ol,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsxs)(e.strong,{children:["Install ",(0,n.jsx)(e.code,{children:"rustup"})]}),": Visit the ",(0,n.jsx)(e.a,{href:"https://www.rust-lang.org/tools/install",children:"Rust official website"})," and run the installation command according to your operating system. It's usually:"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"curl"})," ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--proto"})," ",(0,n.jsx)(e.span,{className:"token string",children:"'=https'"})," ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--tlsv1.2"})," ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"-sSf"})," https://sh.rustup.rs ",(0,n.jsx)(e.span,{className:"token operator",children:"|"})," ",(0,n.jsx)(e.span,{className:"token function",children:"sh"}),` `]})})}),(0,n.jsxs)(e.p,{children:["During the installation, you'll be prompted to choose an installation method; the default is fine. After installation, it might prompt you to configure the ",(0,n.jsx)(e.code,{children:"PATH"})," environment variable for your current shell. Reopen your terminal or execute the suggested command (e.g., ",(0,n.jsx)(e.code,{children:"source $HOME/.cargo/env"}),")."]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Verify Installation"}),": Open a new terminal and enter the following commands to verify if ",(0,n.jsx)(e.code,{children:"rustc"})," and ",(0,n.jsx)(e.code,{children:"cargo"})," are installed successfully:"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsxs)(e.code,{className:"language-bash code-highlight",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:["rustc ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--version"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--version"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:["rustup ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--version"}),` `]})]})})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Install Basic Components (Recommended)"}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:["rustup component ",(0,n.jsx)(e.span,{className:"token function",children:"add"}),` rustfmt clippy rust-analyzer `]})})}),(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.code,{children:"rustfmt"})," is for code formatting, ",(0,n.jsx)(e.code,{children:"clippy"})," for static code analysis and linting, and ",(0,n.jsx)(e.code,{children:"rust-analyzer"})," is a powerful language server for IDE integration."]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Configure IDE/Editor"}),":"]}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"VS Code (Recommended)"}),": Install the ",(0,n.jsx)(e.code,{children:"rust-analyzer"})," extension. It will automatically use the ",(0,n.jsx)(e.code,{children:"rust-analyzer"})," installed by ",(0,n.jsx)(e.code,{children:"rustup"}),"."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"JetBrains IDEs (e.g., IntelliJ IDEA, CLion)"}),": Install the official Rust plugin."]}),(0,n.jsx)(e.li,{children:"Other editors like Neovim, Sublime Text, etc., also have corresponding Rust support plugins."})]})]}),(0,n.jsx)(e.li,{children:(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"(Optional) Install Additional Tools"}),": Based on your needs, use ",(0,n.jsx)(e.code,{children:"cargo install "})," to install other useful tools from the table above, such as ",(0,n.jsx)(e.code,{children:"cargo-edit"}),", ",(0,n.jsx)(e.code,{children:"wasm-pack"}),", ",(0,n.jsx)(e.code,{children:"cargo-watch"}),", etc."]})})]}),(0,n.jsx)(e.h2,{id:"rusts-workspace-concept",children:"Rust's Workspace Concept"}),(0,n.jsxs)(e.p,{children:["A Workspace is a Cargo feature that allows you to manage multiple related Rust packages (crates) under a shared top-level ",(0,n.jsx)(e.code,{children:"Cargo.toml"})," file. This is very useful for large projects or monorepo-style repositories."]}),(0,n.jsx)(e.p,{children:(0,n.jsx)(e.strong,{children:"Why Use a Workspace?"})}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.strong,{children:["Shared ",(0,n.jsx)(e.code,{children:"Cargo.lock"})]}),": All member crates within the workspace share the same ",(0,n.jsx)(e.code,{children:"Cargo.lock"})," file, ensuring consistency of dependency versions."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Unified Build/Test"}),": You can build or test all member crates at once from the top-level directory."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Internal Dependencies"}),": Member crates can easily reference each other using path dependencies."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Code Organization"}),": Split a large project into multiple logically independent, individually compilable small packages."]})]}),(0,n.jsx)(e.p,{children:(0,n.jsx)(e.strong,{children:"How to Create a Workspace?"})}),(0,n.jsxs)(e.ol,{children:[(0,n.jsx)(e.li,{children:(0,n.jsxs)(e.p,{children:["Create a top-level directory, for example, ",(0,n.jsx)(e.code,{children:"my_workspace"}),"."]})}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:["In this directory, create a ",(0,n.jsx)(e.code,{children:"Cargo.toml"})," file with the following content:"]}),(0,n.jsx)(e.pre,{className:"language-toml",children:(0,n.jsxs)(e.code,{className:"code-highlight language-toml",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),(0,n.jsx)(e.span,{className:"token class-name table",children:"workspace"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token property key",children:"members"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[" ",(0,n.jsx)(e.span,{className:"token string",children:'"crate_one"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Points to a subdirectory named crate_one"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[" ",(0,n.jsx)(e.span,{className:"token string",children:'"crate_two"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Points to a subdirectory named crate_two"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:[" ",(0,n.jsx)(e.span,{className:"token comment",children:'# "libs/my_lib", # Can also be a deeper path'}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"]"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"7",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Optional: Define shared metadata or configuration for all crates in the workspace"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"9",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# [profile.release]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"10",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# lto = true"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"11",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# codegen-units = 1"}),` `]})]})})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:["In the ",(0,n.jsx)(e.code,{children:"my_workspace"})," directory, create subdirectories for each member crate and initialize them using ",(0,n.jsx)(e.code,{children:"cargo new"}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsxs)(e.code,{className:"language-bash code-highlight",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token class-name builtin",children:"cd"}),` my_workspace `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"}),` new crate_one `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," new ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--lib"}),` crate_two `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# cargo new libs/my_lib --lib # If there are deeper levels"}),` `]})]})})]})]}),(0,n.jsx)(e.p,{children:"The directory structure might look like this:"}),(0,n.jsx)(e.pre,{className:"language-js",children:(0,n.jsxs)(e.code,{className:"code-highlight language-js",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:["my_workspace",(0,n.jsx)(e.span,{className:"token operator",children:"/"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:["\u251C\u2500\u2500 ",(0,n.jsx)(e.span,{className:"token maybe-class-name",children:"Cargo"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"."}),(0,n.jsx)(e.span,{className:"token property-access",children:"toml"})," # ",(0,n.jsx)(e.span,{className:"token maybe-class-name",children:"Workspace"}),` root configuration file `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:["\u251C\u2500\u2500 ",(0,n.jsx)(e.span,{className:"token maybe-class-name",children:"Cargo"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"."}),(0,n.jsx)(e.span,{className:"token property-access",children:"lock"})," # ",(0,n.jsx)(e.span,{className:"token maybe-class-name",children:"Shared"})," lock file ",(0,n.jsx)(e.span,{className:"token keyword control-flow",children:"for"}),` all members `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:["\u251C\u2500\u2500 target",(0,n.jsx)(e.span,{className:"token operator",children:"/"})," # ",(0,n.jsx)(e.span,{className:"token maybe-class-name",children:"Shared"})," build output directory ",(0,n.jsx)(e.span,{className:"token keyword control-flow",children:"for"}),` all members `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:["\u251C\u2500\u2500 crate_one",(0,n.jsx)(e.span,{className:"token operator",children:"/"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:["\u2502 \u251C\u2500\u2500 ",(0,n.jsx)(e.span,{className:"token maybe-class-name",children:"Cargo"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"."}),(0,n.jsx)(e.span,{className:"token property-access",children:"toml"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"7",children:["\u2502 \u2514\u2500\u2500 src",(0,n.jsx)(e.span,{className:"token operator",children:"/"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:["\u2502 \u2514\u2500\u2500 main",(0,n.jsx)(e.span,{className:"token punctuation",children:"."}),(0,n.jsx)(e.span,{className:"token property-access",children:"rs"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"9",children:["\u2514\u2500\u2500 crate_two",(0,n.jsx)(e.span,{className:"token operator",children:"/"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"10",children:[" \u251C\u2500\u2500 ",(0,n.jsx)(e.span,{className:"token maybe-class-name",children:"Cargo"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"."}),(0,n.jsx)(e.span,{className:"token property-access",children:"toml"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"11",children:[" \u2514\u2500\u2500 src",(0,n.jsx)(e.span,{className:"token operator",children:"/"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"12",children:[" \u2514\u2500\u2500 lib",(0,n.jsx)(e.span,{className:"token punctuation",children:"."}),(0,n.jsx)(e.span,{className:"token property-access",children:"rs"}),` `]})]})}),(0,n.jsx)(e.p,{children:(0,n.jsx)(e.strong,{children:"Common Workspace Commands (executed in the top-level directory):"})}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"cargo build --workspace"}),": Build all member crates."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"cargo test --workspace"}),": Test all member crates."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"cargo clippy --workspace --all-targets"}),": Perform clippy checks on all member crates."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"cargo run -p "}),": Run a specific binary crate in the workspace."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.code,{children:"cargo build -p "}),": Build a specific crate in the workspace."]})]}),(0,n.jsx)(e.h2,{id:"developing-a-rust-package-crate",children:"Developing a Rust Package (Crate)"}),(0,n.jsx)(e.p,{children:'A "package" or "crate" is the fundamental unit of compilation and distribution for Rust code.'}),(0,n.jsxs)(e.ol,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Creating a New Package"}),":"]}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:["Create a library:",(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," new my_library ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--lib"}),` `]})})}),"This will generate ",(0,n.jsx)(e.code,{children:"my_library/src/lib.rs"})," and ",(0,n.jsx)(e.code,{children:"my_library/Cargo.toml"}),"."]}),(0,n.jsxs)(e.li,{children:["Create a binary application:",(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"}),` new my_application `]})})}),"This will generate ",(0,n.jsx)(e.code,{children:"my_application/src/main.rs"})," and ",(0,n.jsx)(e.code,{children:"my_application/Cargo.toml"}),"."]})]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsxs)(e.strong,{children:["Editing ",(0,n.jsx)(e.code,{children:"Cargo.toml"})]}),": This is the package's manifest file, describing its metadata and dependencies."]}),(0,n.jsx)(e.pre,{className:"language-toml",children:(0,n.jsxs)(e.code,{className:"code-highlight language-toml",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),(0,n.jsx)(e.span,{className:"token class-name table",children:"package"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token property key",children:"name"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token string",children:'"my_library"'})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Package name"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[(0,n.jsx)(e.span,{className:"token property key",children:"version"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token string",children:'"0.1.0"'})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Version number (follows SemVer)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[(0,n.jsx)(e.span,{className:"token property key",children:"edition"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token string",children:'"2021"'})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Rust edition (usually 2018 or 2021)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:[(0,n.jsx)(e.span,{className:"token property key",children:"authors"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),(0,n.jsx)(e.span,{className:"token string",children:'"Your Name "'}),(0,n.jsx)(e.span,{className:"token punctuation",children:"]"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Author information"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:[(0,n.jsx)(e.span,{className:"token property key",children:"description"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token string",children:'"A cool library I made."'})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Package description"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"7",children:[(0,n.jsx)(e.span,{className:"token property key",children:"license"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token string",children:'"MIT OR Apache-2.0"'})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# License (SPDX format)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:[(0,n.jsx)(e.span,{className:"token property key",children:"repository"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token string",children:'"https://github.com/your_username/my_library"'})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Code repository URL (optional)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"9",children:[(0,n.jsx)(e.span,{className:"token property key",children:"readme"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token string",children:'"README.md"'})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# README file (optional)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"10",children:[(0,n.jsx)(e.span,{className:"token property key",children:"keywords"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),(0,n.jsx)(e.span,{className:"token string",children:'"tag1"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token string",children:'"tag2"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:"]"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Keywords (optional, for crates.io search)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"11",children:[(0,n.jsx)(e.span,{className:"token property key",children:"categories"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),(0,n.jsx)(e.span,{className:"token string",children:'"category-slug"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:"]"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Categories (optional, consult crates.io category list)"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"12",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"13",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),(0,n.jsx)(e.span,{className:"token class-name table",children:"dependencies"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"14",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Add your dependencies here"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"15",children:[(0,n.jsx)(e.span,{className:"token comment",children:'# serde = { version = "1.0", features = ["derive"] }'}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"16",children:[(0,n.jsx)(e.span,{className:"token comment",children:'# tokio = { version = "1", features = ["full"] }'}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"17",children:[(0,n.jsx)(e.span,{className:"token comment",children:'# rand = "0.8"'}),` `]})]})}),(0,n.jsxs)(e.p,{children:["Using ",(0,n.jsx)(e.code,{children:"cargo add "})," (requires ",(0,n.jsx)(e.code,{children:"cargo-edit"}),") is a convenient way to add dependencies."]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Writing Code"}),":"]}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:["For libraries (",(0,n.jsx)(e.code,{children:"src/lib.rs"}),"): Define public APIs (using the ",(0,n.jsx)(e.code,{children:"pub"})," keyword)."]}),(0,n.jsx)(e.pre,{className:"language-rust",children:(0,n.jsxs)(e.code,{className:"code-highlight language-rust",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// src/lib.rs"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token comment",children:"/// Adds one to the number given."}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[(0,n.jsx)(e.span,{className:"token comment",children:"///"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[(0,n.jsx)(e.span,{className:"token comment",children:"/// # Examples"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:[(0,n.jsx)(e.span,{className:"token comment",children:"///"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:[(0,n.jsx)(e.span,{className:"token comment",children:"/// ```"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"7",children:[(0,n.jsx)(e.span,{className:"token comment",children:"/// let arg = 5;"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:[(0,n.jsx)(e.span,{className:"token comment",children:"/// let answer = my_library::add_one(arg);"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"9",children:[(0,n.jsx)(e.span,{className:"token comment",children:"///"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"10",children:[(0,n.jsx)(e.span,{className:"token comment",children:"/// assert_eq!(6, answer);"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"11",children:[(0,n.jsx)(e.span,{className:"token comment",children:"/// ```"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"12",children:[(0,n.jsx)(e.span,{className:"token keyword",children:"pub"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"fn"})," ",(0,n.jsx)(e.span,{className:"token function function-definition",children:"add_one"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),"x",(0,n.jsx)(e.span,{className:"token punctuation",children:":"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"i32"}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"->"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"i32"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"13",children:[" x ",(0,n.jsx)(e.span,{className:"token operator",children:"+"})," ",(0,n.jsx)(e.span,{className:"token number",children:"1"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"14",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"15",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"16",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// Unit tests are usually placed in the same file or a submodule"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"17",children:[(0,n.jsx)(e.span,{className:"token attr-name attribute",children:"#[cfg(test)]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"18",children:[(0,n.jsx)(e.span,{className:"token keyword",children:"mod"})," ",(0,n.jsx)(e.span,{className:"token namespace module-declaration",children:"tests"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"19",children:[" ",(0,n.jsx)(e.span,{className:"token keyword",children:"use"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"super"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"::"}),(0,n.jsx)(e.span,{className:"token operator",children:"*"}),(0,n.jsx)(e.span,{className:"token punctuation",children:";"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"// Import functions from the outer module"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"20",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"21",children:[" ",(0,n.jsx)(e.span,{className:"token attr-name attribute",children:"#[test]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"22",children:[" ",(0,n.jsx)(e.span,{className:"token keyword",children:"fn"})," ",(0,n.jsx)(e.span,{className:"token function function-definition",children:"it_works"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"23",children:[" ",(0,n.jsx)(e.span,{className:"token property macro",children:"assert_eq!"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token function",children:"add_one"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token number",children:"2"}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token number",children:"3"}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"}),(0,n.jsx)(e.span,{className:"token punctuation",children:";"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"24",children:[" ",(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"25",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]})]})})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:["For binary applications (",(0,n.jsx)(e.code,{children:"src/main.rs"}),"): Implement the ",(0,n.jsx)(e.code,{children:"main"})," function."]}),(0,n.jsx)(e.pre,{className:"language-rust",children:(0,n.jsxs)(e.code,{className:"code-highlight language-rust",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// src/main.rs"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// If my_library is a dependency (assuming it's in the same workspace or published)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// use my_library::add_one;"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"4",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:[(0,n.jsx)(e.span,{className:"token keyword",children:"fn"})," ",(0,n.jsx)(e.span,{className:"token function function-definition",children:"main"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:[" ",(0,n.jsx)(e.span,{className:"token comment",children:"// let num = 5;"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"7",children:[" ",(0,n.jsx)(e.span,{className:"token comment",children:'// println!("{} plus one is {}!", num, add_one(num));'}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:[" ",(0,n.jsx)(e.span,{className:"token property macro",children:"println!"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token string",children:'"Hello from my_application!"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"}),(0,n.jsx)(e.span,{className:"token punctuation",children:";"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"9",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]})]})})]})]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Building and Running"}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsxs)(e.code,{className:"language-bash code-highlight",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," build ",(0,n.jsx)(e.span,{className:"token comment",children:"# Development build"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," build ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--release"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Optimized build (artifacts in target/release/)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," run ",(0,n.jsx)(e.span,{className:"token comment",children:"# (For binary applications only) Compile and run"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," check ",(0,n.jsx)(e.span,{className:"token comment",children:"# Quickly check code without generating an executable"}),` `]})]})})]})]}),(0,n.jsx)(e.h2,{id:"unit-testing",children:"Unit Testing"}),(0,n.jsx)(e.p,{children:"Rust has built-in support for unit tests and integration tests."}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Unit Tests"}),": Usually placed in the same file as the code being tested, within a ",(0,n.jsx)(e.code,{children:"mod tests { ... }"})," module marked with ",(0,n.jsx)(e.code,{children:"#[cfg(test)]"}),". They are used to test private functions or small pieces of logic within a module."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Integration Tests"}),": Placed in the ",(0,n.jsx)(e.code,{children:"tests"})," directory at the project root (e.g., ",(0,n.jsx)(e.code,{children:"tests/my_integration_test.rs"}),"). Each file is a separate crate and can only test the public API of the library crate."]})]}),(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Writing Unit Tests"}),":"]}),(0,n.jsxs)(e.p,{children:["In ",(0,n.jsx)(e.code,{children:"src/lib.rs"})," or ",(0,n.jsx)(e.code,{children:"src/main.rs"})," (or other module files):"]}),(0,n.jsx)(e.pre,{className:"language-rust",children:(0,n.jsxs)(e.code,{className:"code-highlight language-rust",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// ... your code ..."}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token keyword",children:"pub"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"fn"})," ",(0,n.jsx)(e.span,{className:"token function function-definition",children:"multiply"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),"a",(0,n.jsx)(e.span,{className:"token punctuation",children:":"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"i32"}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," b",(0,n.jsx)(e.span,{className:"token punctuation",children:":"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"i32"}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"->"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"i32"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[" a ",(0,n.jsx)(e.span,{className:"token operator",children:"*"}),` b `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"5",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:[(0,n.jsx)(e.span,{className:"token attr-name attribute",children:"#[cfg(test)]"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"// This configuration attribute tells Rust to compile and run this code only when running tests"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"7",children:[(0,n.jsx)(e.span,{className:"token keyword",children:"mod"})," ",(0,n.jsx)(e.span,{className:"token namespace module-declaration",children:"tests"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:[" ",(0,n.jsx)(e.span,{className:"token keyword",children:"use"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"super"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"::"}),(0,n.jsx)(e.span,{className:"token operator",children:"*"}),(0,n.jsx)(e.span,{className:"token punctuation",children:";"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"// Import all items from the outer module (i.e., the module where multiply is defined)"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"9",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"10",children:[" ",(0,n.jsx)(e.span,{className:"token attr-name attribute",children:"#[test]"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"// This attribute marks a function as a test function"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"11",children:[" ",(0,n.jsx)(e.span,{className:"token keyword",children:"fn"})," ",(0,n.jsx)(e.span,{className:"token function function-definition",children:"multiply_works"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"12",children:[" ",(0,n.jsx)(e.span,{className:"token property macro",children:"assert_eq!"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token function",children:"multiply"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token number",children:"2"}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token number",children:"3"}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token number",children:"6"}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token string",children:'"2 times 3 should be 6"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"}),(0,n.jsx)(e.span,{className:"token punctuation",children:";"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"13",children:[" ",(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"14",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"15",children:[" ",(0,n.jsx)(e.span,{className:"token attr-name attribute",children:"#[test]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"16",children:[" ",(0,n.jsx)(e.span,{className:"token keyword",children:"fn"})," ",(0,n.jsx)(e.span,{className:"token function function-definition",children:"multiply_by_zero"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"17",children:[" ",(0,n.jsx)(e.span,{className:"token property macro",children:"assert_eq!"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token function",children:"multiply"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token number",children:"5"}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token number",children:"0"}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token number",children:"0"}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"}),(0,n.jsx)(e.span,{className:"token punctuation",children:";"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"18",children:[" ",(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"19",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"20",children:[" ",(0,n.jsx)(e.span,{className:"token attr-name attribute",children:"#[test]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"21",children:[" ",(0,n.jsx)(e.span,{className:"token attr-name attribute",children:"#[should_panic]"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"// Marks that this test is expected to panic"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"22",children:[" ",(0,n.jsx)(e.span,{className:"token keyword",children:"fn"})," ",(0,n.jsx)(e.span,{className:"token function function-definition",children:"test_panic"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"23",children:[" ",(0,n.jsx)(e.span,{className:"token comment",children:'// panic!("This test is supposed to panic!");'}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"24",children:[" ",(0,n.jsx)(e.span,{className:"token comment",children:"// If there's an expected panic message, you can use:"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"25",children:[" ",(0,n.jsx)(e.span,{className:"token comment",children:'// #[should_panic(expected = "specific message")]'}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"26",children:[" ",(0,n.jsx)(e.span,{className:"token property macro",children:"assert!"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token number",children:"1"})," ",(0,n.jsx)(e.span,{className:"token operator",children:"=="})," ",(0,n.jsx)(e.span,{className:"token number",children:"0"}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token string",children:'"This will panic, as expected by the test"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"}),(0,n.jsx)(e.span,{className:"token punctuation",children:";"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"27",children:[" ",(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"28",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]})]})}),(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Running Tests"}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsxs)(e.code,{className:"language-bash code-highlight",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," ",(0,n.jsx)(e.span,{className:"token class-name builtin",children:"test"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Run only test functions with a specific name"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"3",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," ",(0,n.jsx)(e.span,{className:"token class-name builtin",children:"test"}),` multiply_works `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Run tests only from a specific module"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," ",(0,n.jsx)(e.span,{className:"token class-name builtin",children:"test"})," tests:: ",(0,n.jsx)(e.span,{className:"token comment",children:"# (Note the trailing ::, if the module name is tests)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Show output during tests (println!, etc.)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"7",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," ",(0,n.jsx)(e.span,{className:"token class-name builtin",children:"test"}),` -- --show-output `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Run integration tests (if the tests/ directory exists)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"9",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," ",(0,n.jsx)(e.span,{className:"token class-name builtin",children:"test"})," ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--test"})," ",(0,n.jsx)(e.span,{className:"token operator",children:"<"}),"integration_test_filename_without_rs_extension",(0,n.jsx)(e.span,{className:"token operator",children:">"}),` `]})]})}),(0,n.jsx)(e.h2,{id:"build-artifacts-and-publishing",children:"Build Artifacts and Publishing"}),(0,n.jsx)(e.h3,{id:"build-artifacts",children:"Build Artifacts"}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Development Build (Debug Build)"}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"}),` build `]})})}),(0,n.jsxs)(e.p,{children:["Artifacts are located in the ",(0,n.jsx)(e.code,{children:"target/debug/"})," directory. Compilation is fast, includes debugging information, and is not heavily optimized."]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Release Build"}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," build ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--release"}),` `]})})}),(0,n.jsxs)(e.p,{children:["Artifacts are located in the ",(0,n.jsx)(e.code,{children:"target/release/"})," directory. Compilation is slower, heavily optimized, and suitable for deployment."]})]})]}),(0,n.jsx)(e.h3,{id:"publishing-to-cratesio",children:"Publishing to crates.io"}),(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.code,{children:"crates.io"})," is the Rust community's official package registry."]}),(0,n.jsxs)(e.ol,{children:[(0,n.jsx)(e.li,{children:(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Create an Account"}),": Visit ",(0,n.jsx)(e.a,{href:"https://crates.io/",children:"crates.io"})," and log in using your GitHub account."]})}),(0,n.jsx)(e.li,{children:(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Get API Token"}),": In your Account Settings page, find API access and generate a new token."]})}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Login to Cargo"}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," login ",(0,n.jsx)(e.span,{className:"token operator",children:"<"}),"your_api_token",(0,n.jsx)(e.span,{className:"token operator",children:">"}),` `]})})}),(0,n.jsxs)(e.p,{children:["This will save the token in ",(0,n.jsx)(e.code,{children:"~/.cargo/credentials.toml"}),"."]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Prepare Your Crate"}),":"]}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:["Ensure the metadata in ",(0,n.jsx)(e.code,{children:"Cargo.toml"})," is complete and accurate (name, version, authors, description, license, repository, readme, keywords, categories)."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Version Number"}),": Follow Semantic Versioning (SemVer). Increment the version number before each new release."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Documentation"}),": Good documentation is important. Use ",(0,n.jsx)(e.code,{children:"cargo doc --open"})," to check."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.strong,{children:"Testing"}),": Ensure all tests pass (",(0,n.jsx)(e.code,{children:"cargo test"}),")."]})]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Package Check (Optional but Recommended)"}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"}),` package `]})})}),(0,n.jsxs)(e.p,{children:["This creates a ",(0,n.jsx)(e.code,{children:".crate"})," file (located in ",(0,n.jsx)(e.code,{children:"target/package/"}),") and performs some pre-publishing checks. You can unpack this file (",(0,n.jsx)(e.code,{children:"tar -xzf -.crate"}),") to see what files are included in the package and ensure no unnecessary content is included. If you want to exclude certain files or directories from packaging, you can create a ",(0,n.jsx)(e.code,{children:".gitignore"})," file (if using Git) or a ",(0,n.jsx)(e.code,{children:".cargoignore"})," file in the project root."]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Publish"}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"}),` publish `]})})}),(0,n.jsxs)(e.p,{children:["Cargo will build your package and upload it to ",(0,n.jsx)(e.code,{children:"crates.io"}),"."]}),(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Note"}),":"]}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:["Once a specific version of a crate is published, that version cannot be overwritten or deleted (but you can ",(0,n.jsx)(e.code,{children:"cargo yank"})," it to prevent new projects from depending on it)."]}),(0,n.jsxs)(e.li,{children:["Package names are unique on ",(0,n.jsx)(e.code,{children:"crates.io"}),"."]})]})]})]}),(0,n.jsx)(e.h3,{id:"publishing-to-npm-usually-for-webassembly",children:"Publishing to npm (Usually for WebAssembly)"}),(0,n.jsxs)(e.p,{children:["Compiling Rust code to WebAssembly (Wasm) and publishing to npm is typically done using the ",(0,n.jsx)(e.code,{children:"wasm-pack"})," tool."]}),(0,n.jsxs)(e.ol,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsxs)(e.strong,{children:["Install ",(0,n.jsx)(e.code,{children:"wasm-pack"})]}),":"]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"cargo"})," ",(0,n.jsx)(e.span,{className:"token function",children:"install"}),` wasm-pack `]})})})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Project Configuration"}),":"]}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:["In ",(0,n.jsx)(e.code,{children:"Cargo.toml"}),", set the crate type to ",(0,n.jsx)(e.code,{children:"cdylib"})," (dynamic system library), which is necessary for generating Wasm modules. Also, keep ",(0,n.jsx)(e.code,{children:"rlib"})," so that other Rust projects can depend on it as a library.",(0,n.jsx)(e.pre,{className:"language-toml",children:(0,n.jsxs)(e.code,{className:"code-highlight language-toml",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),(0,n.jsx)(e.span,{className:"token class-name table",children:"lib"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token property key",children:"crate-type"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),(0,n.jsx)(e.span,{className:"token string",children:'"cdylib"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," ",(0,n.jsx)(e.span,{className:"token string",children:'"rlib"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:"]"}),` `]})]})})]}),(0,n.jsxs)(e.li,{children:["Add the ",(0,n.jsx)(e.code,{children:"wasm-bindgen"})," dependency. ",(0,n.jsx)(e.code,{children:"wasm-bindgen"})," is used to facilitate data type and function call conversions between Wasm modules and JavaScript.",(0,n.jsx)(e.pre,{className:"language-toml",children:(0,n.jsxs)(e.code,{className:"code-highlight language-toml",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"["}),(0,n.jsx)(e.span,{className:"token class-name table",children:"dependencies"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token property key",children:"wasm-bindgen"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"="})," ",(0,n.jsx)(e.span,{className:"token string",children:'"0.2"'})," ",(0,n.jsx)(e.span,{className:"token comment",children:"# Use the latest compatible version"}),` `]})]})})]})]})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Writing Rust Code (Wasm Compatible)"}),": Use the ",(0,n.jsx)(e.code,{children:"#[wasm_bindgen]"})," macro to mark functions and structs that need to be exposed to JavaScript."]}),(0,n.jsx)(e.pre,{className:"language-rust",children:(0,n.jsxs)(e.code,{className:"code-highlight language-rust",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// src/lib.rs"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:[(0,n.jsx)(e.span,{className:"token keyword",children:"use"})," ",(0,n.jsxs)(e.span,{className:"token namespace",children:["wasm_bindgen",(0,n.jsx)(e.span,{className:"token punctuation",children:"::"}),"prelude",(0,n.jsx)(e.span,{className:"token punctuation",children:"::"})]}),(0,n.jsx)(e.span,{className:"token operator",children:"*"}),(0,n.jsx)(e.span,{className:"token punctuation",children:";"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"3",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// When compiling for the wasm32-unknown-unknown target,"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// JavaScript's console.log can be accessed via web_sys::console::log_1."}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// extern crate web_sys;"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"7",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// macro_rules! log {"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"8",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// ( $( $t:tt )* ) => {"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"9",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// web_sys::console::log_1(&format!( $( $t )* ).into());"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"10",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// }"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"11",children:[(0,n.jsx)(e.span,{className:"token comment",children:"// }"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"12",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"13",children:[(0,n.jsx)(e.span,{className:"token attr-name attribute",children:"#[wasm_bindgen]"})," ",(0,n.jsx)(e.span,{className:"token comment",children:"// Expose to JavaScript"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"14",children:[(0,n.jsx)(e.span,{className:"token keyword",children:"pub"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"fn"})," ",(0,n.jsx)(e.span,{className:"token function function-definition",children:"greet"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),"name",(0,n.jsx)(e.span,{className:"token punctuation",children:":"})," ",(0,n.jsx)(e.span,{className:"token operator",children:"&"}),(0,n.jsx)(e.span,{className:"token keyword",children:"str"}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"->"})," ",(0,n.jsx)(e.span,{className:"token class-name",children:"String"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"15",children:[" ",(0,n.jsx)(e.span,{className:"token property macro",children:"format!"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),(0,n.jsx)(e.span,{className:"token string",children:'"Hello from Rust, {}!"'}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," name",(0,n.jsx)(e.span,{className:"token punctuation",children:")"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"16",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"17",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"18",children:[(0,n.jsx)(e.span,{className:"token attr-name attribute",children:"#[wasm_bindgen]"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"19",children:[(0,n.jsx)(e.span,{className:"token keyword",children:"pub"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"fn"})," ",(0,n.jsx)(e.span,{className:"token function function-definition",children:"add"}),(0,n.jsx)(e.span,{className:"token punctuation",children:"("}),"a",(0,n.jsx)(e.span,{className:"token punctuation",children:":"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"u32"}),(0,n.jsx)(e.span,{className:"token punctuation",children:","})," b",(0,n.jsx)(e.span,{className:"token punctuation",children:":"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"u32"}),(0,n.jsx)(e.span,{className:"token punctuation",children:")"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"->"})," ",(0,n.jsx)(e.span,{className:"token keyword",children:"u32"})," ",(0,n.jsx)(e.span,{className:"token punctuation",children:"{"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"20",children:[" a ",(0,n.jsx)(e.span,{className:"token operator",children:"+"}),` b `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"21",children:[(0,n.jsx)(e.span,{className:"token punctuation",children:"}"}),` `]})]})})]}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Build Wasm Package"}),": Run ",(0,n.jsx)(e.code,{children:"wasm-pack"})," in your crate's root directory."]}),(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsxs)(e.code,{className:"language-bash code-highlight",children:[(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Build for browser environments (generates ES Modules)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"2",children:["wasm-pack build ",(0,n.jsx)(e.span,{className:"token parameter variable",children:"--target"}),` web `]}),(0,n.jsx)(e.span,{className:"code-line line-number",line:"3",children:` `}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"4",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# Other targets:"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"5",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# wasm-pack build --target bundler (suitable for bundlers like webpack)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"6",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# wasm-pack build --target nodejs (suitable for Node.js environments)"}),` `]}),(0,n.jsxs)(e.span,{className:"code-line line-number",line:"7",children:[(0,n.jsx)(e.span,{className:"token comment",children:"# wasm-pack build --target no-modules (generates global variables, not recommended)"}),` `]})]})}),(0,n.jsxs)(e.p,{children:["This will create a ",(0,n.jsx)(e.code,{children:"pkg"})," directory in your project root. This directory contains the ",(0,n.jsx)(e.code,{children:".wasm"})," file, JavaScript glue code, TypeScript definition files (",(0,n.jsx)(e.code,{children:".d.ts"}),"), and a ",(0,n.jsx)(e.code,{children:"package.json"}),"."]})]}),(0,n.jsx)(e.li,{children:(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Test Wasm Package (Optional)"}),": ",(0,n.jsx)(e.code,{children:"wasm-pack test --headless --firefox"})," (or ",(0,n.jsx)(e.code,{children:"--chrome"}),", ",(0,n.jsx)(e.code,{children:"--safari"}),") can run Wasm tests written in Rust."]})}),(0,n.jsxs)(e.li,{children:[(0,n.jsxs)(e.p,{children:[(0,n.jsx)(e.strong,{children:"Publish to npm"}),":"]}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:["Navigate to the ",(0,n.jsx)(e.code,{children:"pkg"})," directory:",(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token class-name builtin",children:"cd"}),` pkg `]})})})]}),(0,n.jsxs)(e.li,{children:["(Optional) Edit ",(0,n.jsx)(e.code,{children:"pkg/package.json"}),": ",(0,n.jsx)(e.code,{children:"wasm-pack"})," automatically generates one. You can modify fields like ",(0,n.jsx)(e.code,{children:"name"}),", ",(0,n.jsx)(e.code,{children:"version"}),", ",(0,n.jsx)(e.code,{children:"description"}),", ",(0,n.jsx)(e.code,{children:"repository"}),", ",(0,n.jsx)(e.code,{children:"files"}),", etc., as needed. Ensure the ",(0,n.jsx)(e.code,{children:"name"})," is unique on npm. If you want to use an npm scope (e.g., ",(0,n.jsx)(e.code,{children:"@your-npm-username/package-name"}),"), modify it accordingly."]}),(0,n.jsxs)(e.li,{children:["Log in to npm (if not already logged in):",(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"npm"}),` login `]})})})]}),(0,n.jsxs)(e.li,{children:["Publish the package:",(0,n.jsx)(e.pre,{className:"language-bash",children:(0,n.jsx)(e.code,{className:"language-bash code-highlight",children:(0,n.jsxs)(e.span,{className:"code-line line-number",line:"1",children:[(0,n.jsx)(e.span,{className:"token function",children:"npm"}),` publish `]})})}),"If you're using an npm scope and the package is private, you might need ",(0,n.jsx)(e.code,{children:"npm publish --access public"})," for the initial public release."]})]}),(0,n.jsxs)(e.p,{children:["Now, your Rust-Wasm package can be used in JavaScript/TypeScript projects via ",(0,n.jsx)(e.code,{children:"npm install "})," or ",(0,n.jsx)(e.code,{children:"yarn add "}),"."]})]})]}),(0,n.jsx)(e.h2,{id:"-recommended-learning-resources",children:"\u{1F4DA} Recommended Learning Resources"}),(0,n.jsxs)(e.ul,{children:[(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://www.rust-lang.org/",children:"Rust Official Website"})," - The starting point for all Rust information."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://doc.rust-lang.org/book/",children:"The Rust Programming Language Book"}),' - The authoritative guide to learning Rust, also known as "The Book".']}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://doc.rust-lang.org/rust-by-example/",children:"Rust by Example"})," - Learn Rust through a series of examples."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://crates.io",children:"Crates.io Package Registry"})," - The place to find and publish Rust packages."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://docs.rs",children:"docs.rs Documentation Index"})," - Documentation hosting for all crates published on ",(0,n.jsx)(e.code,{children:"crates.io"}),"."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://arewelearningyet.com/",children:"Are We Learning Yet?"})," - Tracks the maturity of the Rust ecosystem in various domains."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://this-week-in-rust.org/",children:"This Week in Rust"})," - Weekly news from the Rust community."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://github.com/rust-lang/rustlings",children:"Rustlings Interactive Exercises"})," - Learn Rust syntax and concepts by fixing small exercises."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://rust-cookbook.com/",children:"Rust Cookbook"})," - Examples of Rust implementations for common programming tasks."]}),(0,n.jsxs)(e.li,{children:[(0,n.jsx)(e.a,{href:"https://rustwasm.github.io/docs/book/",children:"Rust and WebAssembly Book"})," - The official guide to Rust and WebAssembly development."]})]})]})}function h(a={}){let{wrapper:e}=a.components||{};return e?(0,n.jsx)(e,{...a,children:(0,n.jsx)(d,{...a})}):d(a)}return f(v);})(); ;return Component;

All Posts Of Tag Rust