Skip to main content

ProjectBuilder

Struct ProjectBuilder 

Source
pub struct ProjectBuilder { /* private fields */ }
Expand description

Programmatic, dependency-free construction of a Project.

Unlike Project::load, this needs no Cargo.toml, no cargo metadata, and no TOML parsing: a caller that already holds the package facts supplies them directly. The scope, name and version are required; every other field defaults.

Implementations§

Source§

impl ProjectBuilder

Source

pub fn git_url(self, git_url: impl Into<String>) -> Self

npm git URL recorded in the meta package.json repository field.

Source

pub fn description(self, description: impl Into<String>) -> Self

Source

pub fn author(self, author: impl Into<String>) -> Self

Author entry in Name <email> form.

Source

pub fn license(self, license: impl Into<String>) -> Self

Source

pub fn repository(self, repository: impl Into<String>) -> Self

Raw repository URL exposed to manifest substitution.

Source

pub fn bin(self, bin: impl Into<String>) -> Self

Cargo bin name to build and ship; defaults to the package name.

Source

pub fn package(self, package: impl Into<String>) -> Self

Cargo package passed as --package to the build.

Source

pub fn config(self, config: Config) -> Self

Targets, payload and manifests to generate.

Source

pub fn workspace_root(self, workspace_root: impl Into<PathBuf>) -> Self

Root the payload and manifest sources are read from, and where the build runs.

Source

pub fn target_directory(self, target_directory: impl Into<PathBuf>) -> Self

Cargo target directory the compiled binaries are copied from.

Source

pub fn build(self) -> Result<Project, ProjectError>

Validate the required fields and assemble the Project.

Trait Implementations§

Source§

impl Clone for ProjectBuilder

Source§

fn clone(&self) -> ProjectBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProjectBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more