Struct libcnb_data::launch::ProcessBuilder

pub struct ProcessBuilder { /* private fields */ }

Implementations

impl ProcessBuilder

A non-consuming builder for Process values.

Examples

ProcessBuilder::new(process_type!("web"), "java")
    .arg("-jar")
    .arg("target/application-1.0.0.jar")
    .default(true)
    .build();

pub fn new(type: ProcessType, command: impl Into<String>) -> Self

Constructs a new ProcessBuilder with the following defaults:

• No arguments to the process
• direct is false
• default is false
• working_directory will be WorkingDirectory::App.

pub fn arg(&mut self, arg: impl Into<String>) -> &mut Self

Adds an argument to the process.

Only one argument can be passed per use. So instead of:

.arg("-C /path/to/repo")

usage would be:

.arg("-C")
.arg("/path/to/repo")

To pass multiple arguments see args.

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

Adds multiple arguments to pass to the process.

To pass a single argument see arg.

pub fn direct(&mut self, value: bool) -> &mut Self

Sets the direct flag on the process.

If this is true, the lifecycle will launch the command directly, rather than via a shell.

pub fn default(&mut self, value: bool) -> &mut Self

Sets the default flag on the process.

Indicates that the process type should be selected as the buildpack-provided default during the export phase.

pub fn working_directory(&mut self, value: WorkingDirectory) -> &mut Self

Set the working directory for the process.

pub fn build(&self) -> Process

Builds the Process based on the configuration of this builder.