Struct fbp::fbp_iidmessage::IIDMessage

pub struct IIDMessage { /* fields omitted */ }

Provides the structure of a message that is sent between FBP nodes.

Implementations

impl IIDMessage

pub fn new(msg_type: MessageType, payload: Option<String>) -> Self

Creates a new IIDMessage with a specific type and optional payload

An IIDMesage may or may not have a payload. If no payload is required then None can be passed as the payload.

Example

Basic usage:

use fbp::fbp_iidmessage::*;

let a_msg = IIDMessage::new(MessageType::Data, Some("This is a payload".to_string()));

pub fn msg_type(&self) -> MessageType

Retrieves a message’s msg_type

Example

Basic usage:

use fbp::fbp_iidmessage::*;

let a_msg = IIDMessage::new(MessageType::Data, Some("This is a payload".to_string()));

match a_msg.msg_type() {
	MessageType::Data => { /* Deal with a Data Message */ },
	MessageType::Config => { /* Deal with a Config Message */ },
	MessageType::Process => { /* Deal with a Process Message */ },
	_ => { /* Invalid or unknown message type */ },
};

pub fn sub_msg_type(&self) -> SubMessageType

Retrieves a messages’s subtype

Example

Basic usage:

use fbp::fbp_iidmessage::*;

pub fn deal_with_msg(a_msg: IIDMessage) {
	if a_msg.sub_msg_type() == SubMessageType::Reply {
		// ignore the message
	}
}

pub fn payload(&self) -> &Option<String>

Retrieves a messages’s payload

Example

Basic usage:

use fbp::fbp_iidmessage::*;

pub fn process_msg(a_msg: IIDMessage) {
	let msg_payload = a_msg.payload();
	if msg_payload.is_some() {
		// do something with the payload
	}
}

pub fn sub_msg_type_mut(&mut self) -> &mut SubMessageType

Returns a mutable reference to the messages’s submesssage type so that it maybe changed.

Example

Basic usage:

use fbp::fbp_iidmessage::*;

pub fn set_msg_reply(a_msg: &mut IIDMessage) {
	*a_msg.sub_msg_type_mut() =  SubMessageType::Reply;
}

Trait Implementations

impl Clone for IIDMessage

fn clone(&self) -> IIDMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IIDMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IIDMessage

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

Deserialize this value from the given Serde deserializer.

impl Serialize for IIDMessage

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

Serialize this value into the given Serde serializer.