Enum State

pub enum State {
    Prepare(PrepareData),
    Stage(StageData),
    Fetch(FetchData),
    Commit(CommitData),
    WaitToReboot(WaitToRebootData),
    Reboot(RebootData),
    DeferReboot(DeferRebootData),
    Complete(CompleteData),
    FailPrepare(FailPrepareData),
    FailStage(FailStageData),
    FailFetch(FailFetchData),
    FailCommit(FailCommitData),
    Canceled(CanceledData),
}

The set of states that a [Monitor] can receive during an update installation attempt.

An installation attempt ends when it enters a terminal state, denoted below as the states on the right-hand side of the diagram with no arrows leading out of them.

State Machine Diagram

                      +----------------+     +----------------+
           +----------|    prepare     |---->|  fail_prepare  |
           |          +----------------+     +----------------+
           |                  |
           |                  v
           |          +----------------+     +----------------+
           +----------|     stage      |---->|   fail_stage   |
           |          +----------------+     +----------------+
           |                  |
           |                  v
           |          +----------------+     +----------------+
           +----------|     fetch      |---->|   fail_fetch   |
           |          +----------------+     +----------------+
           |                  |
           |                  v
           |          +----------------+     +----------------+
           +----------|     commit     |---->|   fail_commit  |
           |          +----------------+     +----------------+
           v                  |
   +----------------+         |              +----------------+
   |    canceled    |         +------------> |    complete    |
   +----------------+         |              +----------------+
                              v
                      +----------------+     +----------------+
                      | wait_to_reboot |---->|  defer_reboot  |
                      +----------------+     +----------------+
                              |
                              |              +----------------+
                              +------------->|     reboot     |
                                             +----------------+

Variants

Prepare(PrepareData)

Fetching required metadata to begin the update and verifying system state.

Next States:

• stage system is ready to install the update.
• fail_prepare on error.
• canceled on cancel.

Stage(StageData)

Fetching and writing kernel and firmware images.

Next States:

• fetch required kernel and firmware images are written.
• fail_stage on error.
• canceled on cancel.

Fetch(FetchData)

Fetching packages.

Next States:

• commit packages were fetched successfully.
• fail_fetch on error.
• canceled on cancel.

Commit(CommitData)

Prepare to switch over to the new system by writing the packages and switching the active partition.

Next States:

• wait_to_reboot if a reboot is necessary to complete the update.
• complete if no reboot is necessary to complete the update.
• fail_commit on error.
• canceled on cancel.

WaitToReboot(WaitToRebootData)

The system is configured to boot the updated OS on next boot, and the installer is waiting for the trigger to reboot the system.

Next States:

• reboot when the installer decides it is time to initiate the reboot.
• defer_reboot if the initiator specifically requests to not reboot.

Reboot(RebootData)

The installer has initiated a system reboot into the updated OS.

This is a terminal state

DeferReboot(DeferRebootData)

The initiator specifically requested to skip the reboot, but a reboot is still required to complete the update.

This is a terminal state

Complete(CompleteData)

The update is complete and no reboot was required.

This is a terminal state

FailPrepare(FailPrepareData)

An error occurred while preparing the install.

This is a terminal state

FailStage(FailStageData)

An error occurred while staging the images for the OS.

This is a terminal state

FailFetch(FailFetchData)

An error occurred while fetching the required artifacts.

This is a terminal state

FailCommit(FailCommitData)

An error occured while switching partitions.

This is a terminal state

Canceled(CanceledData)

The update is canceled.

This is a terminal state

Implementations

impl State

pub fn ordinal(&self) -> u64

pub fn is_unknown(&self) -> bool

👎Deprecated: Strict unions should not use is_unknown

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<State, D> for State

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl<D: ResourceDialect> Encode<State, D> for &State

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for State

fn eq(&self, other: &State) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMarker for State

type Owned = State

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for State

type Borrowed<'a> = &'a State

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for State

impl StructuralPartialEq for State