Enum Message 

pub enum Message {
    General {
        msgid: u64,
        data: Option<Vec<u8>>,
    },
    Configuration {
        msgid: u64,
        gateway: String,
        data: Option<Vec<u8>>,
    },
    Control {
        msgid: u64,
        srcid: u64,
        action: String,
        target: String,
        data: Option<Vec<u8>>,
    },
    Ack {
        msgid: u64,
        ack: u64,
    },
    Error {
        msgid: u64,
        reason: String,
    },
    StdOut {
        msgid: u64,
        srcid: u64,
        nodes: String,
        data: Option<Vec<u8>>,
    },
    StdErr {
        msgid: u64,
        srcid: u64,
        nodes: String,
        data: Option<Vec<u8>>,
    },
    Retcode {
        msgid: u64,
        srcid: u64,
        retcode: i32,
        nodes: String,
    },
    Timeout {
        msgid: u64,
        srcid: u64,
        nodes: String,
    },
    Routing {
        msgid: u64,
        srcid: u64,
        event: String,
        gateway: String,
        targets: String,
    },
    Start {
        msgid: u64,
    },
    End {
        msgid: u64,
    },
}

A communication message in the propagation tree protocol.

Messages are tagged unions representing the different message types exchanged between ClusterShell nodes. Each variant carries the fields specific to that message type.

Variants

General

Generic base message.

Fields

msgid: u64

data: Option<Vec<u8>>

Configuration

Configuration propagation container (ident = “CFG”). Has payload. Carries serialized topology.

Fields

msgid: u64

gateway: String

data: Option<Vec<u8>>

Control

Action request routed through the tree (ident = “CTL”). Has payload. Carries serialized command data.

Fields

msgid: u64

srcid: u64

action: String

target: String

data: Option<Vec<u8>>

Ack

Acknowledgement message (ident = “ACK”).

Fields

msgid: u64

ack: u64

Error

Error message (ident = “ERR”).

Fields

msgid: u64

reason: String

StdOut

Standard output container (ident = “OUT”). Has payload. Carries encoded output data.

Fields

msgid: u64

srcid: u64

nodes: String

data: Option<Vec<u8>>

StdErr

Standard error container (ident = “SER”). Has payload. Carries encoded stderr data.

Fields

msgid: u64

srcid: u64

nodes: String

data: Option<Vec<u8>>

Retcode

Return code container (ident = “RET”).

Fields

msgid: u64

srcid: u64

retcode: i32

nodes: String

Timeout

Timeout notification (ident = “TIM”).

Fields

msgid: u64

srcid: u64

nodes: String

Routing

Routing notification (ident = “RTR”).

Fields

msgid: u64

srcid: u64

event: String

gateway: String

targets: String

Start

Start of channel communication (ident = “CHA”).

Fields

msgid: u64

End

End of channel communication (ident = “END”).

Fields

msgid: u64

Implementations

impl Message

pub fn general() -> Self

Create a new General message.

pub fn configuration(gateway: &str) -> Self

Create a new Configuration message.

pub fn control(srcid: u64) -> Self

Create a new Control message.

pub fn ack(ackid: u64) -> Self

Create a new Ack message.

pub fn error(reason: &str) -> Self

Create a new Error message.

pub fn stdout(nodes: &str, srcid: u64) -> Self

Create a new StdOut message.

pub fn stderr(nodes: &str, srcid: u64) -> Self

Create a new StdErr message.

pub fn retcode(nodes: &str, retcode: i32, srcid: u64) -> Self

Create a new Retcode message.

pub fn timeout(nodes: &str, srcid: u64) -> Self

Create a new Timeout message.

pub fn routing(event: &str, gateway: &str, targets: &str, srcid: u64) -> Self

Create a new Routing message.

pub fn start() -> Self

Create a Start message.

pub fn end() -> Self

Create an End message.

pub fn ident(&self) -> &str

Get the message type identifier string.

pub fn msgid(&self) -> u64

Get the message ID.

pub fn has_payload(&self) -> bool

Whether this message type carries a payload.

pub fn data(&self) -> Option<&[u8]>

Get a reference to the payload data, if any.

pub fn set_data(&mut self, payload: Vec<u8>)

Set the payload data (raw bytes, will be base64-encoded on serialization).

pub fn data_encode(&mut self, raw: &[u8])

Encode arbitrary bytes as base64 and store as payload.

pub fn data_decode(&self) -> Result<Vec<u8>, MessageProcessingError>

Decode the base64 payload back to raw bytes.

pub fn data_update(&mut self, raw: &[u8]) -> Result<(), MessageProcessingError>

Append data during incremental XML parsing.

pub fn srcid(&self) -> Option<u64>

Get the srcid for routed messages, None for non-routed.

pub fn nodes(&self) -> Option<&str>

Get the nodes field if present.

pub fn xml(&self) -> Vec<u8>

Serialize this message to XML bytes.

Produces output like: <message type="CFG" msgid="0" gateway="gw1">base64payload</message>

pub fn from_attrs( attrs: &HashMap<String, String>, ) -> Result<Message, MessageProcessingError>

Build a message from parsed XML attributes.

The message type is selected based on the “type” attribute, and all other attributes are read according to the variant’s schema.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Self

Returns a duplicate 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 Display for Message

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

Formats the value using the given formatter.