Struct UpdateApi 

pub struct UpdateApi<P: CheckedPermissions> { /* private fields */ }

Implementations

impl<P: CheckedPermissions> UpdateApi<P>

pub fn subscribe_update<S>(&self, context: &mut ServerContext<S>)

where S: Server + ArchiveEventHandler<ProgressUpdate>, P: MessageAllowed<SubscribeUpdateProgress>,

Permission: os/update / SubscribeUpdateProgress

Groups: power-and-firmware.local-update

Sender policy: static-server

Grant timing: policy-only

pub fn start_update(&self, release_paths: Vec<String>)

where P: MessageAllowed<StartUpdate>,

Permission: os/update / StartUpdate

Groups: power-and-firmware.local-update

Sender policy: static-server

Grant timing: policy-only

Apply a series of successive updates to the device, sending progress/error updates to the caller.

If any of the releases require a reboot, the update server with store the information about the remaining releases to be applied and initiate a reboot.

To check whether an update has been stopped midway by a reboot, check UpdateStatus::needs_continue. To resume an update that was stopped midway by a reboot, call Self::continue_update.

NOTE: Paths to the release files must be absolute.

pub fn continue_update(&self)

where P: MessageAllowed<ContinueUpdate>,

Permission: os/update / ContinueUpdate

Groups: power-and-firmware.local-update

Sender policy: static-server

Grant timing: policy-only

Continue an update that was interrupted by a reboot. Make sure that this is called only if UpdateStatus::needs_continue is true.

pub fn firmware_version(&self) -> Result<String, Error>

where P: MessageAllowed<FirmwareVersion>,

Permission: os/update / FirmwareVersion

Groups: power-and-firmware.local-update

Sender policy: static-server

Grant timing: policy-only

Get the current firmware version.

pub fn apply_downloaded_update(&self)

where P: MessageAllowed<ApplyDownloadedUpdate>,

Permission: os/update / ApplyDownloadedUpdate

Groups: power-and-firmware.local-update

Sender policy: static-server

Grant timing: policy-only

Apply the previously downloaded firmware update. This should be called after receiving a messages::ProgressUpdate::DownloadComplete event.

pub fn check_update_applied(&self) -> bool

where P: MessageAllowed<GetUpdateApplied>,

Permission: os/update / GetUpdateApplied

Groups: power-and-firmware.local-update

Sender policy: static-server

Grant timing: policy-only

Check whether an update was applied and is awaiting acknowledgment after reboot.

pub fn clear_update_applied(&self)

where P: MessageAllowed<ClearUpdateApplied>,

Permission: os/update / ClearUpdateApplied

Groups: power-and-firmware.local-update

Sender policy: static-server

Grant timing: policy-only

Clear the update applied flag after acknowledging the update on reboot. Note: The flag is automatically set to true by the update server when applying an update.

pub fn update_status(&self) -> UpdateStatus

where P: MessageAllowed<GetUpdateStatus>,

Permission: os/update / GetUpdateStatus

Groups: power-and-firmware.local-update

Sender policy: static-server

Grant timing: policy-only

Get the current update status, including whether an update is available and if battery is sufficient.

Trait Implementations

impl<P: Clone + CheckedPermissions> Clone for UpdateApi<P>

fn clone(&self) -> UpdateApi<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + CheckedPermissions> Debug for UpdateApi<P>

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

Formats the value using the given formatter.

impl<P: Default + CheckedPermissions> Default for UpdateApi<P>

fn default() -> UpdateApi<P>

Returns the “default value” for a type.