Struct sbp::messages::flash::msg_flash_program::MsgFlashProgram

pub struct MsgFlashProgram {
    pub sender_id: Option<u16>,
    pub target: u8,
    pub addr_start: [u8; 3],
    pub addr_len: u8,
    pub data: Vec<u8>,
}

Program flash addresses

The flash program message programs a set of addresses of either the STM or M25 flash. The device replies with either a MSG_FLASH_DONE message containing the return code FLASH_OK (0) on success, or FLASH_INVALID_LEN (2) if the maximum write size is exceeded. Note that the sector-containing addresses must be erased before addresses can be programmed.

Fields

sender_id: Option<u16>

The message sender_id

target: u8

Target flags

addr_start: [u8; 3]

Starting address offset to program

addr_len: u8

Length of set of addresses to program, counting up from starting address

data: Vec<u8>

Data to program addresses with, with length N=addr_len

Implementations

impl MsgFlashProgram

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 MsgFlashProgram

fn clone(&self) -> MsgFlashProgram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgFlashProgram

const MESSAGE_TYPE: u16 = 230u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_FLASH_PROGRAM"

The message name.

impl Debug for MsgFlashProgram

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

Formats the value using the given formatter.

impl From<MsgFlashProgram> for Sbp

fn from(msg: MsgFlashProgram) -> Self

Converts to this type from the input type.

impl SbpMessage for MsgFlashProgram

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 MsgFlashProgram

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.