Struct ublox_cellular::command::file_system::ReadFile

pub struct ReadFile<'a> {
    pub filename: &'a str,
}

22.4 Read file +URDFILE

Retrieves a file from the file system.

NOTES:

• TOBY-L4 - The stream of file bytes will be provided to the user on a dedicated channel of the USB CDC-ACM interface. If the command is issued on the AT interface over an IP connection, the DCE will send the binary data over the TCP connection to the DTE. The DTE monitors the TCP data port for the binary data transfer (for more details on the TCP/IP port configuration, see the <tcp_data_port> parameter of the +UIFCONF AT command). After the establishment of the TCP connection from the DTE to the specific port, the DCE starts the file transfer. The ‘>’ prompt is not provided to the user on the AT interface over an IP connection. The DCE will close the connection when the specific amount of data is transmitted, or an error result code occurs. Once the AT command is issued, the DCE will listen on the specific port and will close it after the timeout expiration (20 s). The DCE will close the TCP connection, if no data are received for 30 s.
• LARA-R2 / TOBY-R2 / SARA-U2 / LISA-U2 / LISA-U1 - During the command execution, if the DTE stops reading any data from the module (using flow control mechanisms) for 5 s or more, the command could be aborted by the module, and an error result code is returned. In case the DTE is not able to sustain the data flow and to avoid the HW flow control intervention for long time, the use of the +URDBLOCK AT command is recommended.

Fields

filename: &'a str

Trait Implementations

impl<'a> AtatCmd<AtatCmd> for ReadFile<'a>

type Response = ReadFileResponse

The type of the response. Must implement the AtatResp trait.

type Error = GenericError

The type of the error.

fn as_bytes(&self) -> Vec<u8, { ATAT_READFILE_LEN + 13usize }>

Return the command as a heapless Vec of bytes.

fn parse(
    &self,
    res: Result<&[u8], InternalError>
) -> Result<Self::Response, Error<Self::Error>>

Parse the response into a Self::Response or Error<Self::Error> instance.

const CAN_ABORT: bool

Whether or not this command can be aborted.

const MAX_TIMEOUT_MS: u32

The max timeout in milliseconds.

const FORCE_RECEIVE_STATE: bool

Force the ingress manager into receive state immediately after sending the command.

const EXPECTS_RESPONSE_CODE: bool

Force client to look for a response. Empty slice is then passed to parse by client. Implemented to enhance expandability fo ATAT

impl<'a> AtatLen for ReadFile<'a>

const LEN: usize

impl<'a> Clone for ReadFile<'a>

fn clone(&self) -> ReadFile<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Serialize for ReadFile<'a>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.