nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-06-04 19:29:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add rustdoc for ProjectJson methods

Browse Source
This commit is contained in:
Aaron Wood 2020-09-20 12:06:12 -07:00
parent 2fbb09a73f
commit 38f1ce633d
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/project_model/src/project_json.rs
View File

@ -34,6 +34,13 @@ pub struct Crate {
} }
impl ProjectJson { impl ProjectJson {
/// Create a new ProjectJson instance.
///
/// # Arguments
///
/// * `base` - The path to the workspace root (i.e. the folder containing `rust-project.json`)
/// * `data` - The parsed contents of `rust-project.json`, or project json that's passed via
/// configuration.
pub fn new(base: &AbsPath, data: ProjectJsonData) -> ProjectJson { pub fn new(base: &AbsPath, data: ProjectJsonData) -> ProjectJson {
ProjectJson { ProjectJson {
sysroot_src: data.sysroot_src.map(|it| base.join(it)), sysroot_src: data.sysroot_src.map(|it| base.join(it)),
@ -85,12 +92,15 @@ impl ProjectJson {
.collect::<Vec<_>>(), .collect::<Vec<_>>(),
} }
} }
/// Returns the number of crates in the project.
pub fn n_crates(&self) -> usize { pub fn n_crates(&self) -> usize {
self.crates.len() self.crates.len()
} }
/// Returns an iterator over the crates in the project.
pub fn crates(&self) -> impl Iterator<Item = (CrateId, &Crate)> + '_ { pub fn crates(&self) -> impl Iterator<Item = (CrateId, &Crate)> + '_ {
self.crates.iter().enumerate().map(|(idx, krate)| (CrateId(idx as u32), krate)) self.crates.iter().enumerate().map(|(idx, krate)| (CrateId(idx as u32), krate))
} }
/// Returns the path to the project's root folder.
pub fn path(&self) -> &AbsPath { pub fn path(&self) -> &AbsPath {
&self.project_root &self.project_root
} }