Struct Setup 

pub struct Setup { /* private fields */ }

The setup wizard’s state.

It owns the Config while it runs, because settling these three questions is writing that file: the engine, the store and the flag that keeps the wizard from opening again are written when the last step is finished. Setup::into_config hands it back.

Implementations

impl Setup

pub fn new( config: Config, dirs: &HostDirs, gates: &Gates, host: InstallHost, installer: Installer, system: Option<&str>, ) -> Self

A wizard for config on the machine dirs and host describe, opened on the first gate of gates that does not hold.

The gates are asked before the screen appears, not by the screen: their answers decide whether the wizard is needed at all, and the one who asks that question already has them.

system is the language the machine itself is set to, which decides the first row of the language step and, until the person has chosen one, the row that is chosen. It is handed in rather than read here so that a test says what machine it is describing.

pub fn for_step( config: Config, dirs: &HostDirs, gates: &Gates, host: InstallHost, installer: Installer, system: Option<&str>, step: SetupStep, ) -> Self

A wizard that asks step alone, for a setting that has to be put right after the setup was finished: the engine that has gone missing, or a store that has to move.

It shows that one step and finishes on it, so the person is not walked through questions they answered long ago. What it writes is what that step settles; the flag that keeps the wizard from opening at every start is already written and stays written.

pub fn is_alone(&self) -> bool

Whether the wizard is asking one step on its own rather than walking all three.

pub fn step(&self) -> SetupStep

Which step the wizard is on.

pub fn language(&self) -> &'static str

The language the person chose, as the config file writes it.

The wizard applies it to the running application itself; storing it is the caller’s, because the language belongs to the whole application and not to this screen.

pub fn languages(&self) -> &Languages

The languages as the step offers them: the machine’s own first, the rest alphabetical.

pub fn engine_name(&self) -> &'static str

The engine the person chose, as the config file writes it.

pub fn engine_check(&self) -> &EngineCheck

What the chosen engine last answered.

pub fn folder_path(&self) -> Option<&Path>

Where the store will be, once there is an answer to that at all.

pub fn is_finished(&self) -> bool

Whether the wizard is through: everything is settled and written down.

pub fn config(&self) -> &Config

The settings, to read what the wizard has written.

pub fn into_config(self) -> Config

Hands the settings back when the wizard is done with them.

Trait Implementations

impl Debug for Setup

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

Formats the value using the given formatter.