itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-28 11:20:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(test): Expand docs for ProjectBuilder

Browse Source
This commit is contained in:
Ed Page 2024-07-18 20:26:53 -05:00
parent 45f61ccfa8
commit cb528403fa
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/cargo-test-support/src/lib.rs
View File

@ -233,7 +233,13 @@ pub struct Project {
/// Create a project to run tests against
///
/// The project can be constructed programmatically or from the filesystem with [`Project::from_template`]
/// - Creates a [`basic_manifest`] if one isn't supplied
///
/// To get started, see:
/// - [`project`]
/// - [`project_in`]
/// - [`project_in_home`]
/// - [`Project::from_template`]
#[must_use]
pub struct ProjectBuilder {
root: Project,
@ -257,6 +263,7 @@ impl ProjectBuilder {
self.root.target_debug_dir()
}
/// Create project in `root`
pub fn new(root: PathBuf) -> ProjectBuilder {
ProjectBuilder {
root: Project { root },
@ -266,6 +273,7 @@ impl ProjectBuilder {
}
}
/// Create project, relative to [`paths::root`]
pub fn at<P: AsRef<Path>>(mut self, path: P) -> Self {
self.root = Project {
root: paths::root().join(path),