Struct InitOptions 

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

What an installation was asked to do.

Fields

target: Utf8PathBuf

The absolute target repository.

profile: ProfileId

The profile to project.

apply: bool

Write even into a non-empty target with no instance.

dry_run: bool

Preview only, regardless of the target’s state.

plan_zone: Option<PlanZone>

The plan zone to record; None keeps whatever is recorded.

docs_scratch: Option<Option<Utf8PathBuf>>

The docs scratch to record. None keeps whatever is recorded, and Some(None) clears it.

reserve: Vec<String>

Paths to record under reserved: in the instance’s declaration. An empty list keeps whatever is recorded.

writing_style: Option<WritingStyle>

The writing-style selection to record in the declaration. None keeps whatever is recorded.

Trait Implementations

impl Clone for InitOptions

fn clone(&self) -> InitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitOptions

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

Formats the value using the given formatter.