Struct Message

#[repr(C)]
pub struct Message {
    pub sender: *const c_char,
    pub msg_type: MessageType_CEnum,
    pub data_len: u32,
    pub data: *mut c_void,
}

Represents a message sent through the SKSE messaging system.

Fields

sender: *const c_char

The name of the sender as a C string.

msg_type: MessageType_CEnum

The type of message.

data_len: u32

The length of the data buffer.

data: *mut c_void

Pointer to the message data.

Note

The pointer may be invalid, even if data_len is non-zero. Always use Message::get_valid_data to safely access the data.

Implementations

impl Message

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

Returns a valid memory slice of the message data, if accessible.

Safety

• This function checks if the pointer is non-null and properly aligned.
• It also ensures that the memory range is valid before returning a reference.

When None is returned

• If data_len is 0.
• If the data pointer is null, unaligned, or invalid.

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

Formats the value using the given formatter.