Struct sbp::messages::file_io::msg_fileio_read_dir_req::MsgFileioReadDirReq

pub struct MsgFileioReadDirReq {
    pub sender_id: Option<u16>,
    pub sequence: u32,
    pub offset: u32,
    pub dirname: SbpString<Vec<u8>, NullTerminated>,
}

List files in a directory (host => device)

The read directory message lists the files in a directory on the device’s onboard flash file system. The offset parameter can be used to skip the first n elements of the file list. Returns a MSG_FILEIO_READ_DIR_RESP message containing the directory listings as a NULL delimited list. The listing is chunked over multiple SBP packets. The sequence number in the request will be returned in the response. If 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

The offset to skip the first n elements of the file list

dirname: SbpString<Vec<u8>, NullTerminated>

Name of the directory to list

Trait Implementations

impl Clone for MsgFileioReadDirReq

fn clone(&self) -> MsgFileioReadDirReq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgFileioReadDirReq

const MESSAGE_TYPE: u16 = 169u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_FILEIO_READ_DIR_REQ"

The message name.

impl Debug for MsgFileioReadDirReq

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

Formats the value using the given formatter.

impl From<MsgFileioReadDirReq> for Sbp

fn from(msg: MsgFileioReadDirReq) -> Self

Converts to this type from the input type.

impl SbpMessage for MsgFileioReadDirReq

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 MsgFileioReadDirReq

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.