Struct sbp::messages::file_io::msg_fileio_read_req::MsgFileioReadReq
source · pub struct MsgFileioReadReq {
pub sender_id: Option<u16>,
pub sequence: u32,
pub offset: u32,
pub chunk_size: u8,
pub filename: SbpString<Vec<u8>, NullTerminated>,
}
Expand description
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§
source§impl Clone for MsgFileioReadReq
impl Clone for MsgFileioReadReq
source§fn clone(&self) -> MsgFileioReadReq
fn clone(&self) -> MsgFileioReadReq
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl ConcreteMessage for MsgFileioReadReq
impl ConcreteMessage for MsgFileioReadReq
source§const MESSAGE_TYPE: u16 = 168u16
const MESSAGE_TYPE: u16 = 168u16
The message type.
source§const MESSAGE_NAME: &'static str = "MSG_FILEIO_READ_REQ"
const MESSAGE_NAME: &'static str = "MSG_FILEIO_READ_REQ"
The message name.
source§impl Debug for MsgFileioReadReq
impl Debug for MsgFileioReadReq
source§impl<'de> Deserialize<'de> for MsgFileioReadReq
impl<'de> Deserialize<'de> for MsgFileioReadReq
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl FriendlyName for MsgFileioReadReq
impl FriendlyName for MsgFileioReadReq
fn friendly_name() -> &'static str
source§impl From<MsgFileioReadReq> for Sbp
impl From<MsgFileioReadReq> for Sbp
source§fn from(msg: MsgFileioReadReq) -> Self
fn from(msg: MsgFileioReadReq) -> Self
Converts to this type from the input type.
source§impl PartialEq for MsgFileioReadReq
impl PartialEq for MsgFileioReadReq
source§fn eq(&self, other: &MsgFileioReadReq) -> bool
fn eq(&self, other: &MsgFileioReadReq) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl SbpMessage for MsgFileioReadReq
impl SbpMessage for MsgFileioReadReq
source§fn message_name(&self) -> &'static str
fn message_name(&self) -> &'static str
Get the message name.
source§fn message_type(&self) -> Option<u16>
fn message_type(&self) -> Option<u16>
Get the message type.
source§fn set_sender_id(&mut self, new_id: u16)
fn set_sender_id(&mut self, new_id: u16)
Set the sender id.
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Number of bytes this message will take on the wire.
source§fn is_valid(&self) -> bool
fn is_valid(&self) -> bool
Tells you if the message is valid or if it is not a valid message and may need to be
special cased at certain points.
fn into_valid_msg(self) -> Result<Self, Invalid>
source§fn gps_time(&self) -> Option<Result<MessageTime, GpsTimeError>>
fn gps_time(&self) -> Option<Result<MessageTime, GpsTimeError>>
Get the GPS time associated with the message.
source§fn friendly_name(&self) -> &'static str
fn friendly_name(&self) -> &'static str
Get friendly name associated with the message.
source§impl Serialize for MsgFileioReadReq
impl Serialize for MsgFileioReadReq
source§impl TryFrom<Sbp> for MsgFileioReadReq
impl TryFrom<Sbp> for MsgFileioReadReq
impl StructuralPartialEq for MsgFileioReadReq
Auto Trait Implementations§
impl Freeze for MsgFileioReadReq
impl RefUnwindSafe for MsgFileioReadReq
impl Send for MsgFileioReadReq
impl Sync for MsgFileioReadReq
impl Unpin for MsgFileioReadReq
impl UnwindSafe for MsgFileioReadReq
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Event for Twhere
T: ConcreteMessage,
impl<T> Event for Twhere
T: ConcreteMessage,
source§const MESSAGE_TYPES: &'static [u16] = const MESSAGE_TYPES: &'static [u16] = &[T::MESSAGE_TYPE];
const MESSAGE_TYPES: &'static [u16] = const MESSAGE_TYPES: &'static [u16] = &[T::MESSAGE_TYPE];
The message types that correspond to this event. An empty slice means all messages.