Enum embedded_update::Command

pub enum Command<'a> {
    Wait {
        correlation_id: Option<u32>,
        poll: Option<u32>,
    },
    Sync {
        version: Bytes<'a>,
        correlation_id: Option<u32>,
        poll: Option<u32>,
    },
    Write {
        version: Bytes<'a>,
        correlation_id: Option<u32>,
        offset: u32,
        data: Bytes<'a>,
    },
    Swap {
        version: Bytes<'a>,
        correlation_id: Option<u32>,
        checksum: Bytes<'a>,
    },
}

Represents a command issued from the update service to a device.

Variants

Wait

Fields

correlation_id: Option<u32>

Correlation id matching the id sent in the status update.

poll: Option<u32>

The number of seconds the device should wait before sending another status update.

Instruct the device to wait and send its status update at a later time.

Sync

Fields

version: Bytes<'a>

The version that was used for deciding the device was up to date. The device should check it matches its own version.

correlation_id: Option<u32>

Correlation id matching the id sent in the status update.

poll: Option<u32>

The number of seconds the device should wait before sending another status update.

Tell the device that it is up to date and that it can send its status update at a later time.

Write

Fields

version: Bytes<'a>

The firmware version that this block corresponds to. The device should check that this matches version it has been writing so far.

correlation_id: Option<u32>

Correlation id matching the id sent in the status update.

offset: u32

The offset where this block should be written.

data: Bytes<'a>

The firmware data to write.

A block of firmware data that should be written to the device at a given offset.

Swap

Fields

version: Bytes<'a>

The version that was used for deciding the device is ready to swap. The device should check it matches the version being written.

correlation_id: Option<u32>

Correlation id matching the id sent in the status update.

checksum: Bytes<'a>

The full checksum of the firmware being written. The device should compare this with the checksum of the firmware it has written before swapping.

Tell the device that it has now written all of the firmware and that it can commence the swap/update operation.

Implementations

impl<'a> Command<'a>

pub fn new_wait(poll: Option<u32>, correlation_id: Option<u32>) -> Self

Create a new Wait command

pub fn new_sync(
    version: &'a [u8],
    poll: Option<u32>,
    correlation_id: Option<u32>
) -> Self

Create a new Sync command.

pub fn new_swap(
    version: &'a [u8],
    checksum: &'a [u8],
    correlation_id: Option<u32>
) -> Self

Create a new Swap command

pub fn new_write(
    version: &'a [u8],
    offset: u32,
    data: &'a [u8],
    correlation_id: Option<u32>
) -> Self

Create a new Write command.

Trait Implementations

impl<'a> Debug for Command<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Command<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> Serialize for Command<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.