Struct InitArgs 

pub struct InitArgs {
    pub target: Utf8PathBuf,
    pub profile: ProfileId,
    pub apply: bool,
    pub dry_run: bool,
    pub plan_zone: Option<String>,
    pub reserve: Vec<String>,
    pub docs_scratch: Option<String>,
    pub writing_style: Option<String>,
}

Install the payload into a target repository.

Fields

target: Utf8PathBuf

The target repository; must be an absolute path.

profile: ProfileId

The profile to install.

apply: bool

Write into a non-empty target that has no instance yet.

dry_run: bool

Preview only; write nothing.

plan_zone: Option<String>

Where the planning tool writes entry documents: a repository-relative path, untracked:<PATH>, env, or none. Write ./none or ./env for a directory carrying either name. Omitted, the recorded value stays.

reserve: Vec<String>

A path no delivered gate judges, recorded under reserved: in the instance’s declaration. Repeatable.

Use it for a region another tool owns. Omitted, a recorded value stays.

docs_scratch: Option<String>

Where material that is not a statement yet is kept, as a path that may leave the repository, or none to clear a recorded value. Omitted, the recorded value stays.

writing_style: Option<String>

Where the writing style comes from: builtin routes authors to sdd method writing-style, project:<PATH> routes them to the project’s own document, and none installs no route and imposes no conversion obligation. Recorded in the instance’s declaration. Omitted, the recorded value stays.

Trait Implementations

impl Args for InitArgs

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 Debug for InitArgs

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

Formats the value using the given formatter.

impl FromArgMatches for InitArgs

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.