Rust anatomy: Difference between revisions
From wikinotes
(→Crates) |
(→Crates) |
||
Line 39: | Line 39: | ||
src/lib.rs # if this exists, crate is a library | src/lib.rs # if this exists, crate is a library | ||
src/main.rs # if this exists, crate is an executable | src/main.rs # if this exists, crate is an executable | ||
</ | </syntaxhighlight> | ||
You can also specify multiple crates for your package in <code>Cargo.toml</code>. | You can also specify multiple crates for your package in <code>Cargo.toml</code>. | ||
Line 56: | Line 56: | ||
[lib] # <-- single '['s | [lib] # <-- single '['s | ||
# refers to 'src/lib.rs', unless 'path' overrides it | # refers to 'src/lib.rs', unless 'path' overrides it | ||
</ | </syntaxhighlight> | ||
Each of these build targets (lib/bin) is referred to as a '''crate'''. | Each of these build targets (lib/bin) is referred to as a '''crate'''. |
Revision as of 14:38, 8 February 2023
Project Components
A rust project comprises of
packages build/test/share a collection of crates crates tree of modules that build a single library, or executable modules organize scope/privacy of paths paths files ? Packages
A package is a collection of crates.
- it may have multiple executable crates
- it may only have one library crate
myproject/ src/ Cargo.toml Cargo.lockCrates
A crate can be either a library or an executable.
If a package only has a single library/executable, the type can be implied from the source files.
src/lib.rs # if this exists, crate is a library src/main.rs # if this exists, crate is an executableYou can also specify multiple crates for your package in
Cargo.toml
.# Cargo.toml [package] # ... [[bin]] name = "foo" # refers to src/bin/foo.rs [[bin]] name = "bar" # refers to src/bin/bar.rs [lib] # <-- single '['s # refers to 'src/lib.rs', unless 'path' overrides itEach of these build targets (lib/bin) is referred to as a crate.
Modules
Modules contain groups of related srcfiles.
modules are private to their parents by default, and public to their child modules.
the name/namespace of the module mirrors it's filesystem location.
theuse
keyword can merge a module or one of it's elements into the current namespace.See more details in rust modules.