Struct Message

pub struct Message { /* private fields */ }

Represents a message that can be sent between scripts or from the engine.

Example

#[derive(Serialize, Deserialize)]
struct TestMessage {
    value: i32,
}

impl MessageType for TestMessage {
    fn id() -> &'static str {
        "test_message"
    }
}

fn handle(message: &Message) {
    message.handle::<TestMessage>(|m| {
       log::info!("Received message: {}", m.value);
       Ok(())
    }).expect("message handle failed");
}

Implementations

impl Message

pub fn new<T>(value: T) -> Message

where T: MessageType,

Creates a new message with the given value.

pub fn id(&self) -> &str

Returns the message type ID.

pub fn value<T>(&self) -> Result<T, MessageValueError>

where T: MessageType,

Returns the message value as the given type. Returns a MessageValueError if the message has a different type.

pub fn has_type<T>(&self) -> bool

where T: MessageType,

Returns true if the message has the given type.

pub fn handle<T>( &self, f: impl FnOnce(T) -> Result<(), Box<dyn Error>>, ) -> Result<bool, MessageHandleError>

where T: MessageType,

Handle the message with the given handler function. Returns Ok(true) if the message was handled, Ok(false) if the message has a different type, or Err if the message could not be deserialized or the handler function returned an error. The handler function should return Ok(()) if the message was handled successfully.

pub fn send(&self, target: MessageTarget)

Sends the message to the given target.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Message

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

where __S: Serializer,

Serialize this value into the given Serde serializer.