Struct fbp::fbp_iidmessage::ConfigMessage

pub struct ConfigMessage { /* fields omitted */ }

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

Implementations

impl ConfigMessage

pub fn new(msg_type: ConfigMessageType, data: Option<String>) -> Self

Creates a new ConfigMessage with a specific type and optional payload

A ConfigMessage 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::*;

// Assuming that an FBP node has a field called log_file_path, set its value to be Log_file.txt.
// This is done with a JSON string.
let json_config_string = "{\"log_file_path\":\"Log_file.txt\"}".to_string();
let a_msg = ConfigMessage::new(ConfigMessageType::Field, Some(json_config_string));

pub fn msg_type(&self) -> ConfigMessageType

Retrieves an ConfigMessage’s msg_type

Example

Basic usage:

use fbp::fbp_iidmessage::*;

let json_config_string = "{\"log_file_path\":\"Log_file.txt\"}".to_string();
let c_msg = ConfigMessage::new(ConfigMessageType::Field, Some(json_config_string));
let a_msg = c_msg.make_message(MessageType::Config);

match a_msg.msg_type() {
	MessageType::Data => { /* Deal with a Data Message */ },
	MessageType::Config => {
		if a_msg.payload().is_some() {
			let a_config_msg: ConfigMessage =
				ConfigMessage::make_self_from_string(a_msg.payload().clone().unwrap().as_str());
			match a_config_msg.msg_type() {
				ConfigMessageType::Connect => {
					// Deal with a Connect
				},
				ConfigMessageType::Disconnect => {
					// Deal with a Disconnect
				},
				ConfigMessageType::Field => {
					// Deal with setting a field in an FBP node
				}
			};
		}
	},
	MessageType::Process => {
		// Deal with a process message
	},
	_ => {
		// Deal with an invalid or unknown message
	},
};

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

Retrieves a Config messages’s data

Example

Basic usage:

use fbp::fbp_iidmessage::*;

pub fn process_config_msg(a_msg: ConfigMessage) {
	let data = a_msg.data();
	if data.is_some() {
		// do something with the data
	}
}

Trait Implementations

impl Clone for ConfigMessage

fn clone(&self) -> ConfigMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigMessage

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

Deserialize this value from the given Serde deserializer.

impl MessageSerializer for ConfigMessage

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 ConfigMessage

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

Serialize this value into the given Serde serializer.