pub struct StartParameter { /* private fields */ }
Expand description
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§
Source§impl StartParameter
impl StartParameter
Sourcepub fn new() -> StartParameter
pub fn new() -> StartParameter
Creates a new instance of a start parameter with only default settings
Sourcepub fn current_dir(&self) -> &Path
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.
Sourcepub fn mode(&self) -> ConsoleMode
pub fn mode(&self) -> ConsoleMode
The console mode to use
Sourcepub fn project_dir(&self) -> PathBuf
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.
Sourcepub fn properties(&self) -> &HashMap<String, Option<String>>
pub fn properties(&self) -> &HashMap<String, Option<String>>
The project properties set for this build
Sourcepub fn properties_mut(&mut self) -> &mut HashMap<String, Option<String>>
pub fn properties_mut(&mut self) -> &mut HashMap<String, Option<String>>
A mutable reference to the project properties for this build
Sourcepub fn backtrace(&self) -> BacktraceEmit
pub fn backtrace(&self) -> BacktraceEmit
Gets whether the backtrace should be emitted
Sourcepub fn task_requests(&self) -> &[String]
pub fn task_requests(&self) -> &[String]
the task requests used to build this project. Contains both task names and args for said tasks
Sourcepub fn task_requests_mut(&mut self) -> &mut Vec<String>
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
Sourcepub fn with_task_requests<S, I>(self, iter: I) -> StartParameter
pub fn with_task_requests<S, I>(self, iter: I) -> StartParameter
Adds the task requests to this start parameter
Sourcepub fn is_rerun_tasks(&self) -> bool
pub fn is_rerun_tasks(&self) -> bool
Whether to rerun all tasks
Sourcepub fn rerun_tasks(&mut self)
pub fn rerun_tasks(&mut self)
Force all tasks to be re-ran
Sourcepub fn set_current_dir<P>(&mut self, current_dir: P)
pub fn set_current_dir<P>(&mut self, current_dir: P)
Set the current directory
Sourcepub fn set_logging(&mut self, log_level: LoggingArgs)
pub fn set_logging(&mut self, log_level: LoggingArgs)
The level filter to log
Sourcepub fn set_mode(&mut self, mode: ConsoleMode)
pub fn set_mode(&mut self, mode: ConsoleMode)
Sets the console mode
Sourcepub fn set_project_dir<P>(&mut self, project_dir: P)
pub fn set_project_dir<P>(&mut self, project_dir: P)
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§
Source§impl Clone for StartParameter
impl Clone for StartParameter
Source§fn clone(&self) -> StartParameter
fn clone(&self) -> StartParameter
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StartParameter
impl RefUnwindSafe for StartParameter
impl Send for StartParameter
impl Sync for StartParameter
impl Unpin for StartParameter
impl UnwindSafe for StartParameter
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> InstanceOf for T
impl<T> InstanceOf for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more