Struct pavex_cli_client::commands::generate::GenerateBuilder

pub struct GenerateBuilder { /* private fields */ }

The configuration for pavex’s generate command.

You can use Client::generate to start building the command configuration.

Implementations

impl GenerateBuilder

pub fn execute(self) -> Result<(), GenerateError>

Generate the runtime library for the application.

This will invoke pavex with the chosen configuration. It won’t return until pavex has finished running.

If pavex exits with a non-zero status code, this will return an error.

pub fn command(self) -> Result<Command, BlueprintPersistenceError>

Assemble the std::process::Command that will be used to invoke pavex, but do not run it. It will persist the blueprint to a file, though.

This method can be useful if you need to customize the command before running it.
If that’s not your usecase, consider using GenerateBuilder::execute instead.

pub fn diagnostics_path(self, path: PathBuf) -> Self

Set the path to the file that Pavex will use to serialize diagnostic information about the application.

Diagnostics are primarily used for debugging the generator itself.

If this is not set, Pavex will not persist any diagnostic information.

pub fn check(self) -> Self

Enable check mode.

In check mode, pavex generate verifies that the generated server SDK is up-to-date.
If it isn’t, it returns an error without updating the SDK.

pub fn no_check(self) -> Self

Disable check mode.

pavex will regenerate the server SDK and update it on disk if it is outdated.