Struct sbp::messages::settings::MsgSettingsReadByIndexResp

pub struct MsgSettingsReadByIndexResp {
    pub sender_id: Option<u16>,
    pub index: u16,
    pub setting: SbpString<Vec<u8>, Multipart>,
}

Read setting by direct index (host <= device)

The settings message that reports the value of a setting at an index.

In the string field, it reports NULL-terminated and delimited string with contents “SECTION_SETTING\0SETTING\0VALUE\0FORMAT_TYPE\0”. where the ‘\0’ escape sequence denotes the NULL character and where quotation marks are omitted. The FORMAT_TYPE field is optional and denotes possible string values of the setting as a hint to the user. If included, the format type portion of the string has the format “enum:value1,value2,value3”. An example string that could be sent from the device is “simulator\0enabled\0True\0enum:True,False\0”.

Fields

sender_id: Option<u16>

The message sender_id

index: u16

An index into the device settings, with values ranging from 0 to length(settings)

setting: SbpString<Vec<u8>, Multipart>

A NULL-terminated and delimited string with contents “SECTION_SETTING\0SETTING\0VALUE\0FORMAT_TYPE\0”

Trait Implementations

impl Clone for MsgSettingsReadByIndexResp

fn clone(&self) -> MsgSettingsReadByIndexResp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgSettingsReadByIndexResp

const MESSAGE_TYPE: u16

The message type.

const MESSAGE_NAME: &'static str

The message name.

impl Debug for MsgSettingsReadByIndexResp

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

Formats the value using the given formatter.

impl From<MsgSettingsReadByIndexResp> for Sbp

fn from(msg: MsgSettingsReadByIndexResp) -> Self

Performs the conversion.

impl SbpMessage for MsgSettingsReadByIndexResp

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 MsgSettingsReadByIndexResp

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.