Struct sbp::messages::file_io::MsgFileioReadReq

pub struct MsgFileioReadReq {
    pub sender_id: Option<u16>,
    pub sequence: u32,
    pub offset: u32,
    pub chunk_size: u8,
    pub filename: SbpString<Vec<u8>, NullTerminated>,
}

Read file from the file system (host => device)

The file read message reads a certain length (up to 255 bytes) from a given offset into a file, and returns the data in a MSG_FILEIO_READ_RESP message where the message length field indicates how many bytes were successfully read. The sequence number in the request will be returned in the response. If the message is invalid, a followup MSG_PRINT message will print “Invalid fileio read message”. A device will only respond to this message when it is received from sender ID 0x42.

Fields

sender_id: Option<u16>

The message sender_id

sequence: u32

Read sequence number

offset: u32

File offset

chunk_size: u8

Chunk size to read

filename: SbpString<Vec<u8>, NullTerminated>

Name of the file to read from

Trait Implementations

impl Clone for MsgFileioReadReq

fn clone(&self) -> MsgFileioReadReq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgFileioReadReq

const MESSAGE_TYPE: u16

The message type.

const MESSAGE_NAME: &'static str

The message name.

impl Debug for MsgFileioReadReq

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

Formats the value using the given formatter.

impl From<MsgFileioReadReq> for Sbp

fn from(msg: MsgFileioReadReq) -> Self

Performs the conversion.

impl SbpMessage for MsgFileioReadReq

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 MsgFileioReadReq

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.