Struct SETUP 

pub struct SETUP;

Setup service.

This service runs install and uninstall operations sequentially. Operations start once the current app update finishes and there are no other running operations.

Implementations

impl SETUP

pub fn register_task_type<T: SetupTask>(&self)

Register a custom task type.

pub fn install( &self, config: InstallConfig, update: Option<UninstallConfig>, ) -> ResponseVar<Result<UninstallConfig, SetupError>>

Enqueue a new install operation.

This will prepare and commit an install.

Returns a response var that updates once with the result of the operation. If successful an UninstallConfig, this data can be (de)serialized and used with to uninstall.

pub fn prepare_install( &self, config: InstallConfig, update: Option<UninstallConfig>, ) -> ResponseVar<Result<PreparedInstallConfig, SetupError>>

Enqueue a new prepare install operation.

This will run all expensive install operations that can run without affecting the system or previous installs. One reason to run this step separate is to begin an update installation while the application is still running.

If update is set the tasks will use it to find and patch/replace a previous install.

Returns a response var that updates once with the result of the operation. If successful a PreparedInstallConfig, this data can be (de)serialized and used with to commit_install or cancel_prepared.

pub fn cancel_prepared( &self, config: PreparedInstallConfig, ) -> ResponseVar<Result<(), SetupError>>

Enqueue a prepared install cancellation operation.

Note that prepare_install will automatically cancel if requested. This method cancels a prepared install that already completed.

pub fn commit_install( &self, config: PreparedInstallConfig, ) -> ResponseVar<Result<UninstallConfig, SetupError>>

Enqueue a new commit prepared install operation.

This operation cannot be canceled once it starts, if cancel is requested while enqueued the cancel_prepared operation will run instead.

Returns a response var that updates once with the result of the operation. If successful an UninstallConfig, this data can be (de)serialized and used with to uninstall.

pub fn uninstall( &self, config: UninstallConfig, ) -> ResponseVar<Result<(), SetupError>>

Enqueue a new uninstall operation.

This will quickly validate the installation and uninstall. During uninstall the operation cannot be canceled.

Returns a response var that updates once with the result of the operation.

pub fn validate_uninstall( &self, config: UninstallConfig, ) -> ResponseVar<Result<UninstallConfig, SetupError>>

Enqueue a new validate uninstall config operation.

This will verify that the uninstall config can still be used to uninstall.

Returns a response var that updates once with the result of the operation. If successful the config data is returned, potentially corrected if recoverable issues where found.

pub fn status(&self) -> Var<SetupStatus>

Status of running operation.