summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2025-10-28 13:43:53 +0100
committerPaolo Bonzini <pbonzini@redhat.com>2025-12-22 12:01:05 +0100
commit013121d3dda42b2bf70cb53675e3f3fe432b1d97 (patch)
tree7e36bf6874ec904a0fef7dfdf72ef54d693720d2 /docs
parent65e885e1adf0d6735eae9f554ec8f9e94463a950 (diff)
downloadmeson-013121d3dda42b2bf70cb53675e3f3fe432b1d97.tar.gz
modules: rust: add dependencies() method to package object
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Rust-module.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/markdown/Rust-module.md b/docs/markdown/Rust-module.md
index 37ba59d8e..1acb9324b 100644
--- a/docs/markdown/Rust-module.md
+++ b/docs/markdown/Rust-module.md
@@ -269,6 +269,19 @@ Arguments:
- `package_name`: (str, optional) Name of the package; not needed for the
root package of a workspace
+Example usage:
+```meson
+rustmod = import('rust')
+cargo_ws = rustmod.workspace()
+pkg = cargo_ws.package()
+
+executable('my_app', 'src/main.rs',
+ dependencies: pkg.dependencies(),
+ rust_args: pkg.rust_args(),
+ rust_dependency_map: pkg.rust_dependency_map(),
+)
+```
+
### workspace.subproject()
```meson
@@ -353,6 +366,21 @@ dep_map = pkg.rust_dependency_map()
Returns rust dependency mapping for this package.
+#### package.dependencies()
+
+```meson
+deps = pkg.dependencies(...)
+```
+
+Returns a list of dependency objects for all the dependencies required by this
+Rust package, including both Rust crate dependencies and system dependencies.
+The returned dependencies can be used directly in build target declarations.
+
+Keyword arguments:
+- `dependencies`: (`bool`, default: true) Whether to include regular Rust crate dependencies
+- `dev_dependencies`: (`bool`, default: false) Whether to include development dependencies (not yet implemented)
+- `system_dependencies`: (`bool`, default: true) Whether to include system dependencies
+
### Subprojects only
#### subproject.dependency()