Struct sbp::messages::settings::msg_settings_register_resp::MsgSettingsRegisterResp

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

Register setting and default value (device <= host)

This message responds to setting registration with the effective value. The effective value shall differ from the given default value if setting was already registered or is available in the permanent setting storage and had a different value.

Fields

sender_id: Option<u16>

The message sender_id

status: u8

Register status

setting: SbpString<Vec<u8>, Multipart>

A NULL-terminated and delimited string with contents “SECTION_SETTING\0SETTING\0VALUE”. The meaning of value is defined according to the status field.

Implementations

impl MsgSettingsRegisterResp

pub fn register_status(&self) -> Result<RegisterStatus, u8>

Gets the RegisterStatus stored in the status bitfield.

Returns Ok if the bitrange contains a known RegisterStatus variant. Otherwise the value of the bitrange is returned as an Err(u8). This may be because of a malformed message, or because new variants of RegisterStatus were added.

pub fn set_register_status(&mut self, register_status: RegisterStatus)

Set the bitrange corresponding to the RegisterStatus of the status bitfield.

Trait Implementations

impl Clone for MsgSettingsRegisterResp

fn clone(&self) -> MsgSettingsRegisterResp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgSettingsRegisterResp

const MESSAGE_TYPE: u16 = 431u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_SETTINGS_REGISTER_RESP"

The message name.

impl Debug for MsgSettingsRegisterResp

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

Formats the value using the given formatter.

impl From<MsgSettingsRegisterResp> for Sbp

fn from(msg: MsgSettingsRegisterResp) -> Self

Converts to this type from the input type.

impl SbpMessage for MsgSettingsRegisterResp

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 MsgSettingsRegisterResp

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.