Struct Project 

pub struct Project {
    pub identity: Identity,
    pub version: String,
    pub description: String,
    pub author: Author,
    pub license: String,
    pub repository: String,
    pub bin: String,
    pub package: Option<String>,
    pub config: Config,
    pub workspace_root: PathBuf,
    pub target_directory: PathBuf,
}

Everything the pipeline needs to ship one binary as an npm package.

Fields

identity: Identity

version: String

description: String

author: Author

license: String

repository: String

bin: String

Cargo bin name to build and ship; also the npm package name.

package: Option<String>

Owning cargo package, passed as --package to the build.

config: Config

workspace_root: PathBuf

target_directory: PathBuf

Implementations

impl Project

pub fn builder( scope: impl Into<String>, name: impl Into<String>, version: impl Into<String>, ) -> ProjectBuilder

Construct a project programmatically, with no Cargo.toml, cargo metadata, or TOML parsing. The scope, name and version are required.

pub fn discover( manifest_path: &Path, overrides: &Overrides, ) -> Result<Vec<Self>, ProjectError>

Resolve every publishable binary at manifest_path into a project.

Selection mirrors cargo build: by default the workspace’s default-members (or all members), each member’s binaries, skipping libraries and publish = false crates. --package/--workspace/ --exclude/--bin narrow the set exactly as cargo’s flags do. Each binary becomes one npm package named after the binary.

pub fn load( manifest_path: &Path, overrides: &Overrides, ) -> Result<Self, ProjectError>

Resolve a single binary at manifest_path. A convenience over discover for the common one-binary case; errors with ProjectError::NotSingle when the selection matches more than one.

pub fn package_name(&self) -> String

@scope/name meta package name.

pub fn variables(&self) -> BTreeMap<String, String>

Identity values exposed to foreign-manifest substitution.

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Project

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.