Skip to main content

Generator

Struct Generator 

Source
pub struct Generator<'a> { /* private fields */ }
Expand description

Generates the publish tree for one or more Projects into a shared output root, atomically. Construct with Generator::new (single) or Generator::for_projects (a workspace’s bins) and configure with the chained setters.

Implementations§

Source§

impl<'a> Generator<'a>

Source

pub fn new(project: &'a Project) -> Self

Start a generation for a single project.

Source

pub fn for_projects(projects: &'a [Project]) -> Self

Start a generation for several projects (e.g. one per workspace bin) sharing one output root; they are assembled and swapped together.

Source

pub fn build_driver(self, driver: &'a dyn BuildDriver) -> Self

Inject a build driver, overriding the default cargo command. Lets a library consumer or test supply a custom BuildDriver.

Source

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

Output root for the generated tree.

Source

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

Require the resolved version to equal v<tag>.

Source

pub fn no_build(self, no_build: bool) -> Self

Skip the build phase and assemble from existing binaries.

Source

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

Build driver invoked per target (e.g. cargo, cross, cargo-zigbuild).

Source

pub fn targets( self, targets: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Restrict generation to these target keys; empty means all resolved.

Source

pub fn run(&self) -> Result<()>

Build (unless skipped) and assemble every project, then atomically swap the whole tree onto out. Either all projects land or none do.

Trait Implementations§

Source§

impl<'a> Debug for Generator<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Generator<'a>

§

impl<'a> !Send for Generator<'a>

§

impl<'a> !Sync for Generator<'a>

§

impl<'a> !UnwindSafe for Generator<'a>

§

impl<'a> Freeze for Generator<'a>

§

impl<'a> Unpin for Generator<'a>

§

impl<'a> UnsafeUnpin for Generator<'a>

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> 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, 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