Struct fbp::fbp_iidmessage::ProcessMessage

pub struct ProcessMessage {
    pub message_node: Option<Uuid>,
    // some fields omitted
}

Provides the structure of payload of an IIDMessage when the IIDMessage has a type of MessageType::Process

Fields

message_node: Option<Uuid>

Implementations

impl ProcessMessage

pub fn new(msg: ProcessMessageType, propagate: bool) -> Self

Creates a new ProcessMessage with a specific type and a flag to signal if the message shold be propagated

Example

Basic usage:

use fbp::fbp_iidmessage::*;

let p_msg = ProcessMessage::new(ProcessMessageType::Stop, true);

pub fn msg(&self) -> ProcessMessageType

Retrieves a Process message’s type

Example

Basic usage:

use fbp::fbp_iidmessage::*;

pub fn deal_with_process_msg(p_msg: ProcessMessage) {
	if p_msg.msg() == ProcessMessageType::Stop {
		//  Time to stop!
	}
}

pub fn propagate(&self) -> bool

Retrieves a Process message propagate flag

Example

Basic usage:

use fbp::fbp_iidmessage::*;

pub fn should_propagate_process_msg(p_msg: ProcessMessage) -> bool {
	p_msg.propagate()
}

pub fn message_node(&self) -> &Option<Uuid>

Trait Implementations

impl Clone for ProcessMessage

fn clone(&self) -> ProcessMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProcessMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl MessageSerializer for ProcessMessage

fn make_self_from_string<'a, T>(json_string: &'a str) -> T where
    T: Sized + Deserialize<'a>, 

This will deserialize a JSON string that is a serialized Rust struct back into the original struct

fn make_message(&self, msg_type: MessageType) -> IIDMessage where
    Self: Sized + Serialize, 

This will take a struct and serialize that struct into a JSON string that will then become the payload of an IIDMesssage

impl Serialize for ProcessMessage

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

Serialize this value into the given Serde serializer.