Struct ssp::disable::DisableCommand

#[repr(C)]
pub struct DisableCommand { /* private fields */ }

Disable - Command (0x09)

This single byte command disables the unit. This means the unit will enter its disabled state and not execute any further commands or perform any other actions. A poll to the unit while in this state will report disabled (0xE8)

Implementations

impl DisableCommand

pub fn new() -> Self

Creates a new DisableCommand message.

Trait Implementations

impl Clone for DisableCommand

fn clone(&self) -> DisableCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandOps for DisableCommand

fn command(&self) -> MessageType

Gets the Command message type.

fn set_command(&mut self, command: MessageType)

Sets the Command message type.

impl Debug for DisableCommand

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

Formats the value using the given formatter.

impl Default for DisableCommand

fn default() -> Self

Returns the “default value” for a type.

impl Display for DisableCommand

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

Formats the value using the given formatter.

impl MessageOps for DisableCommand

fn init(&mut self)

Common field initialization.

fn buf(&self) -> &[u8]

Gets a reference to the message buffer.

fn buf_mut(&mut self) -> &mut [u8]

Gets a mutable reference to the message buffer.

fn data_len(&self) -> usize

Gets the data length of the message.

fn set_data_len(&mut self, len: u8)

Sets the data length of the message.

fn message_type(&self) -> MessageType

Gets the message type.

fn is_command(&self) -> bool

Gets whether the message is a command message.

fn is_response(&self) -> bool

Gets whether the message is a response message.

fn is_variable(&self) -> bool

Gets whether the message has a variable data length.

fn len(&self) -> usize

Gets the full length of the message buffer.

fn metadata_len(&self) -> usize

Gets the length of the metadata fields in the message buffer.

fn is_empty(&self) -> bool

Gets whether the message contains any data bytes.

fn stx(&self) -> u8

Gets the STX byte.

fn length(&self) -> u8

Gets the data length field.

fn sequence_id(&self) -> SequenceId

Gets the SequenceId field.

fn set_sequence_id(&mut self, id: SequenceId)

Sets the SequenceId field.

fn toggle_sequence_id(&mut self)

Toggles the SequenceFlag value of the SequenceId.

fn data(&self) -> &[u8]

Gets a reference to the data field.

fn data_mut(&mut self) -> &mut [u8]

Gets a mutable reference to the data field.

fn set_data(&mut self, data: &[u8]) -> Result<()>

fn toggle_sequence_flag(&mut self)

Toggles the value of the SequenceFlag.

fn checksum(&self) -> u16

Gets the checksum from the message buffer.

fn calculate_checksum(&mut self) -> u16

Calculates the CRC-16 checksum of the message.

fn verify_checksum(&self) -> Result<()>

Verifies the checksum in the message buffer matches the calculated value.

fn as_bytes(&mut self) -> &[u8]

Gets the message as a byte buffer.

fn as_bytes_mut(&mut self) -> &mut [u8]

Gets the message as a mutable byte buffer.

fn from_buf(&mut self, buf: &[u8]) -> Result<()>

Constructs a message from a byte buffer.

impl PartialEq<DisableCommand> for DisableCommand

fn eq(&self, other: &DisableCommand) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for DisableCommand

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: &[u8]) -> Result<Self>

Performs the conversion.

impl<const N: usize> TryFrom<[u8; N]> for DisableCommand

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: [u8; N]) -> Result<Self>

Performs the conversion.

impl Copy for DisableCommand

impl StructuralPartialEq for DisableCommand