Struct hostlink::protocol::Message

pub struct Message { /* private fields */ }

A complete Hostlink command.

Implementations

impl Message

pub const fn new(node: NodeId, kind: MessageKind, params: MessageParams) -> Self

Creates a new command from the specified node ID and arguments.

pub const fn new_with_empty_params(node: NodeId, kind: MessageKind) -> Self

Creates a new command with no arguments from the specified node ID.

pub const fn kind(&self) -> MessageKind

pub const fn params(&self) -> &MessageParams

pub fn as_device_error(self) -> Result<DeviceError, ProtocolError>

pub fn check_device_error(&self) -> Option<DeviceError>

pub fn serialize(self) -> Result<Box<str>, ProtocolError>

Serializes the command into a string that can be sent to a PLC.

pub fn set_node_id(&mut self, node: NodeId)

pub fn parse(cmd: &str) -> Result<Self, ProtocolError>

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Hash for Message

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 Message

fn cmp(&self, other: &Message) -> 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 Message

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 PartialOrd for Message

fn partial_cmp(&self, other: &Message) -> 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 TryFrom<Message> for Status

type Error = StatusParseError

The type returned in the event of a conversion error.

fn try_from(value: Message) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Message

impl StructuralPartialEq for Message