Struct CommandRequest

pub struct CommandRequest {
    pub command: String,
    pub parameter: String,
    pub command_type: String,
}

A command request to send to the SwitchBot API.

For more details of each field, please refer to the SwitchBot documentation about device control commands.

Examples

let command = CommandRequest {
    command: "turnOn".into(),
    ..Default::default()
};

Fields

command: String

The command.

parameter: String

The command parameters.

command_type: String

The command type.

Trait Implementations

impl Clone for CommandRequest

fn clone(&self) -> CommandRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandRequest

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

Formats the value using the given formatter.

impl Default for CommandRequest

fn default() -> CommandRequest

Returns the “default value” for a type.

impl Display for CommandRequest

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

Convert to a string by:

• Prepend command_type with a / (slash) if it’s not empty nor default.
• Append parameter with a : (colon) if it’s not empty nor default.

This is the same form as what the from(&str) parses.

impl From<&str> for CommandRequest

fn from(text: &str) -> Self

Parse a string into a CommandRequest. Please see the switchbot-cli document for the syntax.

assert_eq!(
    CommandRequest::from("turnOn"),
    CommandRequest {
        command: "turnOn".into(),
        ..Default::default()
    }
);
assert_eq!(
    CommandRequest::from("turnOn:parameter:colon/slash"),
    CommandRequest {
        command: "turnOn".into(),
        parameter: "parameter:colon/slash".into(),
        ..Default::default()
    }
);
assert_eq!(
    CommandRequest::from("customize/turnOn"),
    CommandRequest {
        command: "turnOn".into(),
        command_type: "customize".into(),
        ..Default::default()
    }
);
assert_eq!(
    CommandRequest::from("customize/turnOn:parameter:colon/slash"),
    CommandRequest {
        command: "turnOn".into(),
        command_type: "customize".into(),
        parameter: "parameter:colon/slash".into(),
    }
);

impl PartialEq for CommandRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CommandRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandRequest