Enum hostlink::protocol::EasyCommand

#[non_exhaustive]
pub enum EasyCommand {
    Test(Box<str>),
    StatusRead,
}

A simplified representation of a command.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Test(Box<str>)

Transmits a block of data, which is then repeated by the PLC.

StatusRead

Reads the operating status of the PLC.

Implementations

impl EasyCommand

pub fn make_test<S: AsRef<str>>(data: S) -> Result<Self, ProtocolError>

Construct a Test command with the given data.

Example

use hostlink::protocol::{EasyCommand, Message, MessageKind, MessageParams, NodeId};

// Make up a zero node ID (required by the complex API)
let node = NodeId::new(0).unwrap();

// Make up a test message
let test_message = "hello, world!";

// Create a test command using the easy API:
let easy_test = EasyCommand::make_test(test_message).unwrap();

// Same, using the more complex API:
let params = MessageParams::from(test_message);
let complex_test = Message::new(node, MessageKind::Test, params);

// They're the same
assert_eq!(&easy_test, &complex_test);

pub const fn make_status_read() -> Self

Construct a StatusRead command.

Example

use hostlink::protocol::{EasyCommand, Message, MessageKind, MessageParams, NodeId};

// Make up a zero node ID (required by the complex API)
let node = NodeId::new(0).unwrap();

// Create a status read command using the easy API:
let easy_status = EasyCommand::make_status_read();

// Same, using the more complex API:
let complex_status = Message::new_with_empty_params(node, MessageKind::StatusRead);

// They're the same
assert_eq!(&easy_status, &complex_status);

pub fn into_message(self, node: NodeId) -> Message

Perform conversion into Message.

pub const fn kind(&self) -> MessageKind

Get the command’s message type.

Trait Implementations

impl Clone for EasyCommand

fn clone(&self) -> EasyCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EasyCommand

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

Formats the value using the given formatter.

impl Display for EasyCommand

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

Formats the value using the given formatter.

impl Hash for EasyCommand

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EasyCommand

fn cmp(&self, other: &EasyCommand) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<Message> for EasyCommand

fn eq(&self, other: &Message) -> 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 PartialEq for EasyCommand

fn eq(&self, other: &EasyCommand) -> 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 PartialOrd for EasyCommand

fn partial_cmp(&self, other: &EasyCommand) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for EasyCommand

impl StructuralPartialEq for EasyCommand