Struct StartParameter

pub struct StartParameter { /* private fields */ }

The start parameters define the configuration used by an assemble instance to execute a build.

Generally corresponds to the command line options for assemble.

Implementations

impl StartParameter

pub fn new() -> StartParameter

Creates a new instance of a start parameter with only default settings

pub fn current_dir(&self) -> &Path

Gets the current directory of the start parameter, used to select the default project and find the settings file.

pub fn mode(&self) -> ConsoleMode

The console mode to use

pub fn project_dir(&self) -> PathBuf

The project directory to find the default project. If not set, defaults to the same as the current dir.

pub fn properties(&self) -> &HashMap<String, Option<String>>

The project properties set for this build

pub fn properties_mut(&mut self) -> &mut HashMap<String, Option<String>>

A mutable reference to the project properties for this build

pub fn backtrace(&self) -> BacktraceEmit

Gets whether the backtrace should be emitted

pub fn task_requests(&self) -> &[String]

the task requests used to build this project. Contains both task names and args for said tasks

pub fn task_requests_mut(&mut self) -> &mut Vec<String>

the task requests used to build this project. Contains both task names and args for said tasks

pub fn with_task_requests<S, I>(self, iter: I) -> StartParameter

where S: AsRef<str>, I: IntoIterator<Item = S>,

Adds the task requests to this start parameter

pub fn is_rerun_tasks(&self) -> bool

Whether to rerun all tasks

pub fn rerun_tasks(&mut self)

Force all tasks to be re-ran

pub fn set_current_dir<P>(&mut self, current_dir: P)

where P: AsRef<Path>,

Set the current directory

pub fn set_logging(&mut self, log_level: LoggingArgs)

The level filter to log

pub fn set_mode(&mut self, mode: ConsoleMode)

Sets the console mode

pub fn set_project_dir<P>(&mut self, project_dir: P)

where P: AsRef<Path>,

Sets the project directory used to find the default project

pub fn set_backtrace(&mut self, backtrace: BacktraceEmit)

pub fn workers(&self) -> usize

pub fn set_workers(&mut self, workers: usize)

pub fn logging(&self) -> &LoggingArgs

Trait Implementations

impl Clone for StartParameter

fn clone(&self) -> StartParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartParameter

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

Formats the value using the given formatter.