Struct sbp::messages::flash::msg_flash_erase::MsgFlashErase

pub struct MsgFlashErase {
    pub sender_id: Option<u16>,
    pub target: u8,
    pub sector_num: u32,
}

Erase sector of device flash memory (host => device)

The flash erase message from the host erases a sector of either the STM or M25 onboard flash memory. The device will reply with a MSG_FLASH_DONE message containing the return code - FLASH_OK (0) on success or FLASH_INVALID_FLASH (1) if the flash specified is invalid.

Fields

sender_id: Option<u16>

The message sender_id

target: u8

Target flags

sector_num: u32

Flash sector number to erase (0-11 for the STM, 0-15 for the M25)

Implementations

impl MsgFlashErase

pub fn flash_target_to_read(&self) -> Result<FlashTargetToRead, u8>

Gets the FlashTargetToRead stored in the target bitfield.

Returns Ok if the bitrange contains a known FlashTargetToRead variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of FlashTargetToRead were added.

pub fn set_flash_target_to_read(
    &mut self,
    flash_target_to_read: FlashTargetToRead
)

Set the bitrange corresponding to the FlashTargetToRead of the target bitfield.

Trait Implementations

impl Clone for MsgFlashErase

fn clone(&self) -> MsgFlashErase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgFlashErase

const MESSAGE_TYPE: u16 = 226u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_FLASH_ERASE"

The message name.

impl Debug for MsgFlashErase

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

Formats the value using the given formatter.

impl From<MsgFlashErase> for Sbp

fn from(msg: MsgFlashErase) -> Self

Converts to this type from the input type.

impl SbpMessage for MsgFlashErase

fn message_name(&self) -> &'static str

Get the message name.

fn message_type(&self) -> u16

Get the message type.

fn sender_id(&self) -> Option<u16>

Get the sender_id if it is set.

fn set_sender_id(&mut self, new_id: u16)

Set the sender id.

fn encoded_len(&self) -> usize

Number of bytes this message will take on the wire.

impl TryFrom<Sbp> for MsgFlashErase

type Error = TryFromSbpError

The type returned in the event of a conversion error.

fn try_from(msg: Sbp) -> Result<Self, Self::Error>

Performs the conversion.