Struct CommandMessage 

pub struct CommandMessage {
    pub command_id: u32,
    pub command_name: String,
    pub encoding: u16,
    pub command: String,
}

COMMAND message containing command data with ID and name

OpenIGTLink Specification

• Message type: “COMMAND”
• Body format: COMMAND_ID (uint32) + COMMAND_NAME (char[20]) + ENCODING (uint16) + LENGTH (uint32) + COMMAND (uint8[LENGTH])
• Character encoding: MIBenum value (default: 3 = US-ASCII)

Fields

command_id: u32

Unique ID of this command

command_name: String

Name of the command (max 20 chars)

encoding: u16

Character encoding as MIBenum value Common values:

• 3: US-ASCII (default)
• 106: UTF-8

command: String

The command string (often XML)

Implementations

impl CommandMessage

pub fn new( command_id: u32, command_name: impl Into<String>, command: impl Into<String>, ) -> Self

Create a new COMMAND message with US-ASCII encoding

pub fn utf8( command_id: u32, command_name: impl Into<String>, command: impl Into<String>, ) -> Self

Create a COMMAND message with UTF-8 encoding

pub fn with_encoding( command_id: u32, command_name: impl Into<String>, encoding: u16, command: impl Into<String>, ) -> Self

Create a COMMAND message with custom encoding

pub fn as_str(&self) -> &str

Get the command string as a reference

Trait Implementations

impl Clone for CommandMessage

fn clone(&self) -> CommandMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandMessage

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

Formats the value using the given formatter.

impl Message for CommandMessage

fn message_type() -> &'static str

Returns the message type name (e.g., “TRANSFORM”, “IMAGE”)

fn encode_content(&self) -> Result<Vec<u8>>

Encode message content to bytes

fn decode_content(data: &[u8]) -> Result<Self>

Decode message content from bytes

impl PartialEq for CommandMessage

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

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

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 StructuralPartialEq for CommandMessage