Struct FreightArgs 

pub struct FreightArgs { /* private fields */ }

Command line options for running assemble based projects.

Tasks can either be the full path for the task, or a relative one from the directory in use within the project.

Task options are configured on per task basis and are fully configured at compile time. Options for tasks must immediately follow the task request.

When many tasks are matched for the same task request, they all receive the same task options.

Implementations

impl FreightArgs

pub fn command_line<S: AsRef<str>>(cmd: S) -> Self

Simulate creating the freight args from the command line

pub fn try_command_line<S: AsRef<str>>(cmd: S) -> Result<Self, Error>

Simulate creating the freight args from the command line

pub fn from_env() -> Self

Create a freight args instance from the surrounding environment.

pub fn task_requests( &self, project: &SharedProject, ) -> ProjectResult<TaskRequests>

Generate a task requests value using a shared project

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

Generate a task requests value using a shared project

pub fn with_tasks<'s, I: IntoIterator<Item = &'s str>>( &self, iter: I, ) -> FreightArgs

Creates a clone with different tasks requests

pub fn property(&self, key: impl AsRef<str>) -> Option<&str>

Gets a property.

pub fn logging(&self) -> &LoggingArgs

Gets the logging args

pub fn workers(&self) -> usize

Gets the number of workers

pub fn backtrace(&self) -> BacktraceEmit

Get whether to emit backtraces or not.

pub fn rerun_tasks(&self) -> bool

Get whether to always rerun tasks.

pub fn properties(&self) -> &ProjectProperties

Trait Implementations

impl Args for FreightArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for FreightArgs

fn clone(&self) -> FreightArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for FreightArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for FreightArgs

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

Formats the value using the given formatter.

impl From<FreightArgs> for StartParameter

fn from(args: FreightArgs) -> Self

Converts to this type from the input type.

impl FromArgMatches for FreightArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Merge for FreightArgs

fn merge(&mut self, other: Self)

Merge another object into this object.

impl Parser for FreightArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.